issue 175 - adding an assembly attribute #176
Conversation
|
Updated #175 to summarize the proposal. |
696234e to
3312b13
Compare
| @@ -13,6 +13,14 @@ NOTE: A text snippet is not a module. | |||
| . Create the text snippet AsciiDoc file. | |||
| + | |||
| NOTE: Consider storing snippet files in a separate snippets folder. | |||
|
|
|||
| . Add a variable to the snippet files that that identifies its content type: | |||
There was a problem hiding this comment.
@kalexand-rh Typo "that that"
| @@ -27,13 +27,14 @@ Create assembly and module file names that accurately and closely reflect the ti | |||
| Do not include special characters in file names. Ensure that all members of your team use the same file naming conventions. | |||
| ==== | |||
|
|
|||
| These file naming guidelines are optional but highly recommended. However, if your team does not include the module prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each concept, procedure, and reference module before the module ID: | |||
| These file naming guidelines are optional but highly recommended. However, if your team does not include the module prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each assembly file and concept, procedure, and reference module before the module ID: | |||
There was a problem hiding this comment.
| These file naming guidelines are optional but highly recommended. However, if your team does not include the module prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each assembly file and concept, procedure, and reference module before the module ID: | |
| These file naming guidelines are optional but highly recommended. However, if your team does not include the prefixes in file names followed by either a hyphen (-) or an underscore (_), include one of the following variables in each file before the anchor ID: |
| :_content-type: ASSEMBLY | ||
| :_content-type: CONCEPT | ||
| :_content-type: PROCEDURE | ||
| :_content-type: REFERENCE |
There was a problem hiding this comment.
Just a side note that I think is outside of the scope of this PR. We might want to update the intro section to this chap to also mention snippets, and include a snippet file in the example file names previously in this section, and then add a content-type of SNIPPET to this list. But snippets are still fairly new territory, so not sure if we're to a point that we want to mention it beyond the snippets section later in this guide, which you've correctly updated. So I think good for now unless someone wants to expand this section to include snippets in a separate PR.
|
In mod doc review board meeting Dec 8, 2021, decided to freeze this PR until the dust settles with Jupiter post-Summit to ensure that the requirements don't again change, and also to see at that point if we can get a concrete answer on how the distinction of content and even module type has actual customer value beyond just a new tooling requirement. To be discussed post-Summit. |
Fixes #175