Skip to content

Commit

Permalink
Merge pull request #883 from keberlein/admin-procedures
Browse files Browse the repository at this point in the history
Adding GitHub documentation
  • Loading branch information
keberlein authored Jan 4, 2023
2 parents 59e1f2f + a2fe697 commit 95e3ca1
Show file tree
Hide file tree
Showing 5 changed files with 137 additions and 0 deletions.
Binary file added admin/version-control/images/create-new-fork.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions specification/creating-a-github-account.dita
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
<task id="creating-a-github-account">
<title>Creating a GitHub account</title>
<shortdesc></shortdesc>
<taskbody>
<steps>
<step>
<cmd>Go to <xref href="https://github.com/" format="html"
scope="external"/>.</cmd>
</step>
<step>
<cmd>In the upper right-hand corner of the web page, click
<uicontrol>Signup</uicontrol>.</cmd>
</step>
<step>
<cmd>Follow the instructions to create an account.</cmd>
<info>You will need to provide your e-mail address, select a
password and user ID, select whether you want to receive product
information, and perform a test in order to validate your
account.</info>
</step>
<step>
<cmd>Click <uicontrol>Create account</uicontrol>.</cmd>
<stepresult>GitHub e-mails you a launch code.</stepresult>
</step>
<step>
<cmd>Enter the launch code on the browser page.</cmd>
<info>
<note type="tip">If you have difficulties pasting the launch code
into the browser page, ensure that you have copied a text
version of the launch code.</note>
</info>
</step>
</steps>
</taskbody>
</task>
84 changes: 84 additions & 0 deletions specification/forking-a-dita-tc-repository.dita
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
<task id="forking-a-dita-tc-repository">
<title>Forking a DITA TC repository</title>
<shortdesc>Before you can contribute to a DITA TC specification or
project, you need to fork the relevant GitHub repository. A fork is a
new repository that shares code and visibility settings with the
upstream repository.</shortdesc>
<taskbody>
<steps>
<step>
<cmd>Go to the home page for the repository that you want to
fork:</cmd>
<choicetable relcolwidth="1* 1*" frame="topbot">
<chhead>
<choptionhd>Repository</choptionhd>
<chdeschd>URL</chdeschd>
</chhead>
<chrow>
<choption>DITA</choption>
<chdesc><xref href="https://github.com/oasis-tcs/dita"
format="html" scope="external"/></chdesc>
</chrow>
<chrow>
<choption>DITA for Technical Content</choption>
<chdesc><xref href="https://github.com/oasis-tcs/dita-techcomm"
format="html" scope="external"/></chdesc>
</chrow>
<chrow>
<choption>Lightweight DITA</choption>
<chdesc><xref href="https://github.com/oasis-tcs/dita-lwdita"
format="html" scope="external"/></chdesc>
</chrow>
<chrow>
<choption>DITA TC committee notes</choption>
<chdesc><xref
href="https://github.com/oasis-tcs/dita-committee-notes"
format="html" scope="external"/></chdesc>
</chrow>
<chrow>
<choption>DITA stylesheets</choption>
<chdesc><xref
href="https://github.com/oasis-open/dita-stylesheets"
format="html" scope="external"/></chdesc>
</chrow>
<chrow>
<choption>DITA specializations</choption>
<chdesc><xref
href="https://github.com/oasis-open/dita-specializations"
format="html" scope="external"/></chdesc>
</chrow>
<chrow>
<choption>DITA RNG converter</choption>
<chdesc><xref
href="https://github.com/oasis-open/dita-rng-converter"
format="html" scope="external"/></chdesc>
</chrow>
</choicetable>
</step>
<step>
<cmd>Select the menu for the <uicontrol>Fork</uicontrol> button,
and then click <uicontrol>Create a new fork</uicontrol>.</cmd>
<stepxmp>
<image placement="break"
href="../admin/version-control/images/create-new-fork.jpg"
scale="70"/>
</stepxmp>
</step>
<step>
<cmd>Clear the <uicontrol>Copy the <varname>default</varname>
branch only</uicontrol> check box.</cmd>
</step>
<step>
<cmd>Click <uicontrol>Create fork</uicontrol>.</cmd>
<stepresult>The home page for your personal fork
opens.</stepresult>
</step>
<step>
<cmd>Bookmark the URL for your fork, as you will need it in order
to clone the repository.</cmd>
</step>
</steps>
</taskbody>
</task>
7 changes: 7 additions & 0 deletions specification/performing-version-control.dita
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
<task id="performing-version-control">
<title>Performing version control</title>
<shortdesc>The DITA TC uses a series of GitHub repositories to store
code and DITA source files.</shortdesc>
</task>
9 changes: 9 additions & 0 deletions specification/performing-version-control.ditamap
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
<map>
<title>Performing version control</title>
<topicref href="performing-version-control.dita">
<topicref href="creating-a-github-account.dita"/>
<topicref href="forking-a-dita-tc-repository.dita"/>
</topicref>
</map>

0 comments on commit 95e3ca1

Please sign in to comment.