Skip to content

Commit a34220b

Browse files
authored
Merge pull request #5 from redhat-documentation/Origin-Rename-Update
Correct git command to rename origin.
2 parents dbe6d2d + a6e7d46 commit a34220b

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

Diff for: bpm/index.html

+15-9
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ <h1>KIE/BPM Documentation Contributor Guide</h1>
527527
<div class="sectionbody">
528528
<div class="paragraph">
529529
<p>For KIE/BPM
530-
contributors</p>
530+
contributors.</p>
531531
</div>
532532
</div>
533533
</div>
@@ -1007,7 +1007,7 @@ <h4 id="_procedure" class="float">Procedure</h4>
10071007
<i class="fa icon-tip" title="Tip"></i>
10081008
</td>
10091009
<td class="content">
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 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 note that 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>)
10111011
</td>
10121012
</tr>
10131013
</table>
@@ -2478,13 +2478,13 @@ <h2 id="mod_doc_conventions">6. Modular Documentation Conventions</h2>
24782478
<div class="sect2">
24792479
<h3 id="_anchor_names_and_file_names">6.1. Anchor Names and File Names</h3>
24802480
<div class="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>
24822482
</div>
24832483
<div class="dlist">
24842484
<dl>
24852485
<dt class="hdlist1">Anchor names</dt>
24862486
<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>
24882488
<div class="listingblock">
24892489
<div class="content">
24902490
<pre class="highlight"><code>[#anchor_name]
@@ -2534,6 +2534,9 @@ <h3 id="_anchor_names_and_file_names">6.1. Anchor Names and File Names</h3>
25342534
<dt class="hdlist1">File names</dt>
25352535
<dd>
25362536
<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+
<div class="paragraph">
2538+
<p>For assemblies, however, precede the file name with <code>assembly_</code>. This sets assembled content apart from the content modules.</p>
2539+
</div>
25372540
<div class="ulist">
25382541
<div class="title">Examples</div>
25392542
<ul>
@@ -2552,6 +2555,9 @@ <h3 id="_anchor_names_and_file_names">6.1. Anchor Names and File Names</h3>
25522555
<li>
25532556
<p><code>guided-decision-tables-limitations-ref.adoc</code> (Reference module with limitations)</p>
25542557
</li>
2558+
<li>
2559+
<p><code>assembly_guided-decision-tables.adoc</code> (Assembly of guided decision table modules)</p>
2560+
</li>
25552561
</ul>
25562562
</div>
25572563
</dd>
@@ -2646,9 +2652,6 @@ <h4 id="_procedure_12" class="float">Procedure</h4>
26462652
<dt class="hdlist1">Module Included Multiple Times in a Single Assembly</dt>
26472653
<dd>
26482654
<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>
2649-
</dd>
2650-
</dl>
2651-
</div>
26522655
<div class="listingblock">
26532656
<div class="title">Assembly</div>
26542657
<div class="content">
@@ -2663,6 +2666,9 @@ <h4 id="_procedure_12" class="float">Procedure</h4>
26632666
include::module-A-being-reused.adoc</code></pre>
26642667
</div>
26652668
</div>
2669+
</dd>
2670+
</dl>
2671+
</div>
26662672
</li>
26672673
<li>
26682674
<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>
@@ -2713,7 +2719,7 @@ <h4 id="_practical_example_1_reusing_modules_in_multiple_assemblies" class="floa
27132719
<p>The module files contain the following content:</p>
27142720
</div>
27152721
<div class="listingblock">
2716-
<div class="title">projects-con-adoc</div>
2722+
<div class="title">projects-con.adoc</div>
27172723
<div class="content">
27182724
<pre class="highlight"><code>// Module included in the following assemblies: "assembly_projects.adoc", "assembly_assets.adoc"
27192725

@@ -2789,7 +2795,7 @@ <h4 id="_practical_example_2_reusing_a_module_in_a_single_assembly" class="float
27892795
<p>The module file contains the following content:</p>
27902796
</div>
27912797
<div class="listingblock">
2792-
<div class="title">projects-con-adoc</div>
2798+
<div class="title">projects-con.adoc</div>
27932799
<div class="content">
27942800
<pre class="highlight"><code>[#projects_con_{context}]
27952801
= Projects</code></pre>

0 commit comments

Comments
 (0)