|
9 | 9 | <p>Besides the team of technical writers who have full write access to the documentation
|
10 | 10 | repositories, there may be other collaborators (e.g. subject matter experts) who have
|
11 | 11 | read access to the repository and sometimes want to propose changes.</p>
|
12 |
| - <p>The workflow for proposing changes to a repository usually works like this:<ul |
13 |
| - id="ul_gcj_sbf_twb"> |
14 |
| - <li>The collaborator creates a branch of the project on which they make changes and |
15 |
| - add comments.</li> |
16 |
| - <li>The branch is integrated back into the main project branch by the technical writer.</li> |
17 |
| - </ul></p> |
18 |
| - <p><image |
19 |
| - href="../images/pull-request.png" |
20 |
| - id="image_yyh_ybf_twb"/></p> |
21 |
| - <!--https://mermaid.live/edit#pako:eNqNkUFuAjEMRa8SeU0vMOtWXVVUYldlYxLPJCKJRx6HCiHuToZpKaJUanZ23v_fiY_g2BN0MER9FRyDLaYdxzlHNdF3xsI6eRKzJ5kil8nCA2STMSXjApaBrsRWsLhghPaRPp96Ir9Ft_tSB3I7rvrH7W_vhXuc_i488kT-foBrSMZYllYmGegfoWsN7c03frCCpm1Gvn3WcVZYaEwmCzPvqceadCZPDa2jR6UXH5UFOpVKK8CqvDkU910vzHPEQTBD12OaWnfE8sH8U9PF421Z0mVXpzMviJPY--> |
22 |
| - <p>Git Servers like <b>GitHub</b> or <b>GitLab</b> may add some extra functionality to help |
23 |
| - technical writers review and accept changes. </p> |
| 12 | + <p>The workflow for proposing changes to a repository usually works like this:<ol |
| 13 | + id="ol_jl2_k2w_v2c"> |
| 14 | + <li><b>Identify the Need for a Change</b><p>The SME (subject matter expert) starts |
| 15 | + by reading the published output and thinking about what to change</p></li> |
| 16 | + <li><b>Click “Edit Online”</b><p>They click on an "Edit online" link on the page |
| 17 | + they want to change</p></li> |
| 18 | + <li><b>Make the Edits</b><p>Using the <xref |
| 19 | + href="https://www.oxygenxml.com/xml_web_author.html" format="html" |
| 20 | + scope="external">Oxygen XML Web Author</xref> the SME can make changes |
| 21 | + directly to the DITA topic—no need to download or clone the |
| 22 | + repository.</p></li> |
| 23 | + <li><b>Submit the Changes</b><p>When they try to commit, Web Author automatically |
| 24 | + creates a pull request with their changes</p></li> |
| 25 | + <li><b>Review and Merge</b><p>The technical writer reviews the change, improve the |
| 26 | + content if needed, and merges the pull request.</p></li> |
| 27 | + </ol></p> |
| 28 | + <p>You can see this workflow presented in detail in the video below. Short on time? Jump straight |
| 29 | + to the <xref href="https://www.youtube.com/watch?v=YzQ0XhmtPUI&t=217s" format="html" |
| 30 | + scope="external">demo section</xref> and see it in action. </p> |
| 31 | + <p><object data="https://youtu.be/YzQ0XhmtPUI" outputclass="iframe"/></p> |
24 | 32 | </body>
|
25 | 33 | <related-links>
|
26 | 34 | <link
|
|
0 commit comments