Skip to content

Commit 193dd3f

Browse files
authored
Improve documentation
#295 #294 #293
1 parent 4d35e65 commit 193dd3f

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

doc/main.html

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,13 @@ <h2>Quick start</h2>
6262
<a>https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks</a>.
6363
</li>
6464
<li>
65-
Start editing the main prose element at <code>html-pub-template/doc/main.html</code>.
65+
If working on a project that has a repository, update the <code>origin</code> remote to that repository:
66+
<pre>git remote set-url origin &lt;HTTPS URL of the project repository found on GitHub&gt;</pre>
67+
For example:
68+
<pre>git remote set-url origin https://github.com/SMPTE/stxxx-y-private.git</pre>
69+
</li>
70+
<li>
71+
Start editing the main prose element at <code>doc/main.html</code>.
6672
</li>
6773
</ol>
6874

@@ -2148,7 +2154,9 @@ <h3>Sample Workflow </h3>
21482154
<ol type="a">
21492155
<li>Follow the steps in <a href="#sec-quick-start"></a> to create repo.</li>
21502156
<li>A new branch is created from <code>main</code> called <code>2023-initial-draft</code> (where "2023" is the current year).</li>
2151-
<li>Template document is updated in <code>2023-initial-draft</code> branch to <code>&lt;meta itemprop="pubState" content="draft" /&gt;</code> and to <code>&lt;meta itemprop="pubStage" content="WD" /&gt;</code>.</li>
2157+
<li>Make sure that the <code>pubState</code> (<a href="#sec-pubState"></a>) and <code>pubStage</code> (<a
2158+
href="#sec-pubStage"></a>) of the main prose element in the <code>2023-initial-draft</code> branch are set to
2159+
<code>draft</code> and <code>WD</code>, respectively.</li>
21522160
<li>Document editor creates initial version of the document.</li>
21532161
<li>A PR is created named <code>2023 Initial Draft</code> from the <code>2023-initial-draft</code> branch on GitHub. </li>
21542162
<li>Skip to Workflow Step (4)</li>
@@ -2159,8 +2167,11 @@ <h3>Sample Workflow </h3>
21592167
<ol type="a">
21602168
<li>Assumption: There is a prior release labeled <code>2020115-pub</code></li>
21612169
<li>A new branch is created from <code>main</code> called <code>2023-revision</code> (where "2023" is the current year).</li>
2162-
<li>Document is updated in <code>2023-revision</code> branch to <code>&lt;meta itemprop="pubState" content="draft" /&gt;</code> and to <code>&lt;meta itemprop="pubStage" content="WD" /&gt;</code>.</li>
2163-
<li><code>.smpte-build.json</code> is updated in <code>2023-revision</code> branch to last release tag <code>2020115-pub</code> (see <a href="#sec-document-github-releases"></a>) </li>
2170+
<li>Make sure that the <code>pubState</code> (<a href="#sec-pubState"></a>) and <code>pubStage</code> (<a
2171+
href="#sec-pubStage"></a>) of the main prose element in the <code>2023-initial-draft</code> branch are set to
2172+
<code>draft</code> and <code>WD</code>, respectively.</li>
2173+
<li><code>.smpte-build.json</code> is updated in <code>2023-revision</code> branch to last release tag
2174+
<code>2020115-pub</code> (see <a href="#sec-document-github-releases"></a>) </li>
21642175
<li>Document editor makes initial changes to the document.</li>
21652176
<li>A PR is created named <code>2023 Revision</code> from the <code>2023-revision</code> branch on GitHub. The tooling with create a redline against the most recent edition of the document.</li>
21662177
<li>Continue to Workflow Step (4)</li>

0 commit comments

Comments
 (0)