Added templates for product and feature#22496
Conversation
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-docs canceled.
|
Files changed:
|
templates/concept/product.md
Outdated
|
|
||
| # Overview | ||
|
|
||
| `TODO: What is this product and why is it useful?` |
There was a problem hiding this comment.
i think this template should say what is a product vs what is a feature? if i were just coming upon these templates looking for something to use, i wouldn't know
taroface
left a comment
taroface
left a comment
There was a problem hiding this comment.
Left some thoughts. Also, should have a header for a diagram in at least the product template?
templates/concept/feature.md
Outdated
| --- | ||
|
|
||
| {% comment %} | ||
| `TODO: Is this feature in preview?` |
There was a problem hiding this comment.
Is there a reason this would be on the feature template specifically, and not also product template?
templates/concept/feature.md
Outdated
|
|
||
| `TODO: Relevant technical info on what happens behind the scenes when using this feature` | ||
|
|
||
| # Use this feature |
There was a problem hiding this comment.
I suggest removing this, as it implies we could put task content within a conceptual doc. I don't think we want to do that at this point!
templates/concept/product.md
Outdated
|
|
||
| # Features | ||
|
|
||
| `TODO: Are there prominent aspects of this product that should be pointed out? If a feature can't be fully explained in this section, consider giving it its own concept page.` |
There was a problem hiding this comment.
Maybe clarify that this would link to docs that use the feature template.
3 participants
No description provided.