You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Consider renaming <code>origin</code> your GitHub user name to avoid confusion with other contributors' forks (also named <code>origin</code> by default) when you need to collaborate across forks. To rename your remote, go to the <code>kie-docs</code> repository in your terminal application and run <code>git rename origin $USERNAME</code>. Please note, however, that in any Git commands that refer to <code>origin</code> you will need to use the new remote name instead (example: <code>git push --set-upstream $NEW_NAME $BRANCH_NAME</code>)
1010
+
Consider renaming <code>origin</code> your GitHub user name to avoid confusion with other contributors' forks (also named <code>origin</code> by default) when you need to collaborate across forks. To rename your remote, go to the <code>kie-docs</code> repository in your terminal application and run <code>git remote rename origin $USERNAME</code>. Please notethat going forward, in any Git commands that refer to <code>origin</code> you will need to use the new remote name instead (example: <code>git push --set-upstream $NEW_NAME $BRANCH_NAME</code>)
<h3id="_anchor_names_and_file_names">6.1. Anchor Names and File Names</h3>
2480
2480
<divclass="paragraph">
2481
-
<p>To optimize modular documentation, follow these guidelines for naming topic anchors and files.</p>
2481
+
<p>To optimize modular documentation, follow these guidelines for naming module anchors and files.</p>
2482
2482
</div>
2483
2483
<divclass="dlist">
2484
2484
<dl>
2485
2485
<dtclass="hdlist1">Anchor names</dt>
2486
2486
<dd>
2487
-
<p>Provide an anchor for every module so that it can be identified when reused or cross-referenced. Give the anchor name the same or a similar name to the topic heading, separated by underscores, and indicate the module type (<code>con</code>, <code>ref</code>, <code>proc</code>) at the end of the name. If applicable, consider also providing a module sub-type (<code>create</code>, <code>edit</code>, <code>delete</code>) before the module type:</p>
2487
+
<p>Provide an anchor for every module so that it can be identified when reused or cross-referenced. Give the anchor name the same or a similar name to the module heading, separated by underscores, and indicate the module type (<code>con</code>, <code>ref</code>, <code>proc</code>) at the end of the name. If applicable, consider also providing a module sub-type (<code>create</code>, <code>edit</code>, <code>delete</code>) before the module type:</p>
<p>Give an informative name separated by dashes and indicate the module type (<code>con</code>, <code>ref</code>, <code>proc</code>) at the end of the name. If applicable, consider also providing a module sub-type (<code>create</code>, <code>edit</code>, <code>delete</code>) right before the module type. Indicating the module type and sub-type at the end of the file name instead of the beginning of the file name results in topics being sorted based on subject matter rather than module type. This assortment can be helpful for managing related content.</p>
2537
+
<divclass="paragraph">
2538
+
<p>For assemblies, however, precede the file name with <code>assembly_</code>. This sets assembled content apart from the content modules.</p>
<dtclass="hdlist1">Module Included Multiple Times in a Single Assembly</dt>
2647
2653
<dd>
2648
2654
<p>If a module is included multiple times in the same assembly, then you can define an attribute specific to a section or a chapter of that assembly, such as <code>:context: section-name</code>. This indicates that the reused module is appearing in the context of that section of the assembly.</p>
<p>Return to the reused module file, and at the top of the file add a commented-out note that identifies which assemblies the module has been added to. This helps to track reused modules in the future.</p>
0 commit comments