Skip to content

Commit d36487c

Browse files
committed
Improve documentation
#295 #294 #293
1 parent 4d35e65 commit d36487c

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

doc/main.html

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,18 @@ <h2>Quick start</h2>
6161
(Advanced) Add the pre-commit hook specified at <a href="#sec-tooling-git-hooks"></a> by following the instructions at
6262
<a>https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks</a>.
6363
</li>
64+
<li>
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/st2067-21-private.git</pre>
69+
</li>
6470
<li>
6571
Start editing the main prose element at <code>html-pub-template/doc/main.html</code>.
6672
</li>
73+
<li>
74+
When ready to push your work to the SMPTE reStart editing the main prose element at <code>html-pub-template/doc/main.html</code>.
75+
</li>
6776
</ol>
6877

6978
</section>
@@ -2148,7 +2157,9 @@ <h3>Sample Workflow </h3>
21482157
<ol type="a">
21492158
<li>Follow the steps in <a href="#sec-quick-start"></a> to create repo.</li>
21502159
<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>
2160+
<li>Make sure that the <code>pubState</code> (<a href="#sec-pubState"></a>) and <code>pubStage</code> (<a
2161+
href="#sec-pubStage"></a>) of the main prose element in the <code>2023-initial-draft</code> branch are set to
2162+
<code>draft</code> and <code>WD</code>, respectively.</li>
21522163
<li>Document editor creates initial version of the document.</li>
21532164
<li>A PR is created named <code>2023 Initial Draft</code> from the <code>2023-initial-draft</code> branch on GitHub. </li>
21542165
<li>Skip to Workflow Step (4)</li>
@@ -2159,8 +2170,11 @@ <h3>Sample Workflow </h3>
21592170
<ol type="a">
21602171
<li>Assumption: There is a prior release labeled <code>2020115-pub</code></li>
21612172
<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>
2173+
<li>Make sure that the <code>pubState</code> (<a href="#sec-pubState"></a>) and <code>pubStage</code> (<a
2174+
href="#sec-pubStage"></a>) of the main prose element in the <code>2023-initial-draft</code> branch are set to
2175+
<code>draft</code> and <code>WD</code>, respectively.</li>
2176+
<li><code>.smpte-build.json</code> is updated in <code>2023-revision</code> branch to last release tag
2177+
<code>2020115-pub</code> (see <a href="#sec-document-github-releases"></a>) </li>
21642178
<li>Document editor makes initial changes to the document.</li>
21652179
<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>
21662180
<li>Continue to Workflow Step (4)</li>

0 commit comments

Comments
 (0)