<pre style='margin:0'>
Clemens Lang (neverpanic) pushed a commit to branch master
in repository macports-guide.
</pre>
<p><a href="https://github.com/macports/macports-guide/commit/2b987767202c3203989c1da96c7f9442548bc3b4">https://github.com/macports/macports-guide/commit/2b987767202c3203989c1da96c7f9442548bc3b4</a></p>
<pre style="white-space: pre; background: #F8F8F8">The following commit(s) were added to refs/heads/master by this push:
<span style='display:block; white-space:pre;color:#404040;'> new 2b98776 Split "Updating Documentation" into two sections
</span>2b98776 is described below
<span style='display:block; white-space:pre;color:#808000;'>commit 2b987767202c3203989c1da96c7f9442548bc3b4
</span>Author: Eitan Adler <lists@eitanadler.com>
AuthorDate: Sun Nov 5 09:31:36 2017 -0800
<span style='display:block; white-space:pre;color:#404040;'> Split "Updating Documentation" into two sections
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> This splits the instructions into two sections:
</span><span style='display:block; white-space:pre;color:#404040;'> - one time events
</span><span style='display:block; white-space:pre;color:#404040;'> - every time events
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> While here also convert `orderedlisting` into a `procedure`
</span>---
guide/xml/project.xml | 150 ++++++++++++++++++++++++++------------------------
1 file changed, 78 insertions(+), 72 deletions(-)
<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/xml/project.xml b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;color:#808080;'>index 94d0f76..18dedc0 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -999,87 +999,93 @@ To use the current port, you must be in a port's directory.</screen>
</span> <section id="project.docs.guide">
<title>Updating the Guide</title>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- The sources for this guide are kept in a <ulink url="https://github.com/macports/macports-guide">
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- Git repository on GitHub</ulink>. If you spot any error or outdated information, you are
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- encouraged to submit a pull request following the steps outlined below.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <section id="project.docs.guide.preparing-changes">
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <title>Preparing Changes</title>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>The sources for this guide are kept in a <ulink
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ url="https://github.com/macports/macports-guide"> Git repository on
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ GitHub</ulink>. If you spot any error or outdated information, you are
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ encouraged to submit a pull request following the steps outlined
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ below.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <section id="project.docs.guide.one-time">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <title>One Time Preperations</title>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>In order to submit changes you'll need to do some one time
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ setup.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <procedure>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Visit <ulink
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ url="https://github.com/macports/macports-guide">the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ macports-guide repository on GitHub</ulink> and press the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <guibutton>Fork</guibutton> button in the upper right corner. This
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ will create a macports-guide repository in your own GitHub
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ account.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Clone the sources to your computer:</para>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <orderedlist>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>First, clone the sources to your computer and switch to a new branch for your changes:</para>
</span> <programlisting><prompt>$</prompt> <userinput>git clone https://github.com/macports/macports-guide.git</userinput>
<span style='display:block; white-space:pre;background:#ffe0e0;'>-<!-- --><prompt>$</prompt> <userinput>cd macports-guide</userinput>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-<!-- --><prompt>$</prompt> <userinput>git checkout -b my-changes origin/master</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+<!-- --><prompt>$</prompt> <userinput>cd macports-guide</userinput>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+<!-- --><prompt>$</prompt> <userinput>git remote add <replaceable>username</replaceable> https://github.com/<replaceable>username</replaceable>/macports-guide.git</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- Make your changes to the file in the <filename>guide/xml/</filename> directory that
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- corresponds to the section you want to make changes to.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <programlisting><prompt>$</prompt> <userinput>$EDITOR guide/xml/</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Install the required ports:</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>sudo port install libxslt docbook-xsl</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </procedure>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </section>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <section id="project.docs.guide.each-time">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <title>Proposing a Change</title>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>For each change you want to make:</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <procedure>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Make your changes to the file in the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <filename>guide/xml/</filename> directory that corresponds to the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ section you want to make changes to.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>$EDITOR guide/xml/<replaceable>guide.xml</replaceable></userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Verify your changes are still valid XML.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ If the <command>make validate</command> command reports
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ errors, fix the XML sources until you see no more error
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ messages</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>make validate guide</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Convert the guide to HTML and view the new version in your
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ browser.</para>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- Verify your changes are still valid XML. First, install the required software from
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- MacPorts if you do not already have it installed. If the <command>make validate</command>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- command reports errors, fix the XML sources until you see no more error messages.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <programlisting><prompt>$</prompt> <userinput>sudo port install libxslt docbook-xsl</userinput>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-<!-- --><prompt>$</prompt> <userinput>make validate</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- Convert the guide to HTML and view the new version in your browser.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span> <programlisting><prompt>$</prompt> <userinput>make guide</userinput>
<span style='display:block; white-space:pre;background:#ffe0e0;'>-<!-- --><prompt>$</prompt> <userinput>open guide/html/index.html</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+<prompt>$</prompt> <userinput>open guide/html/index.html</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Commit your changes to the local branch and describe your
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ changes in the commit message. See also our wiki page <ulink
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ url="https://trac.macports.org/wiki/CommitMessages">CommitMessages</ulink>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ that explains how to write good commit messages.</para>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- Commit your changes to the local branch and describe your changes in the commit
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- message. See also our wiki page <ulink url="https://trac.macports.org/wiki/CommitMessages">CommitMessages</ulink>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- that explains how to write good commit messages.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span> <programlisting><prompt>$</prompt> <userinput>git commit -a</userinput></programlisting>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </orderedlist>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </section>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <section id="project.docs.guide.pull-request">
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <title>Creating a Pull Request</title>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- You can submit your changes for inclusion in the guide by making a pull request on GitHub.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Submit the changes for inclusion in the guide by <ulink
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ url="https://help.github.com/articles/creating-a-pull-request/">making
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ a pull request on GitHub</ulink>.</para>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <orderedlist>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- Visit <ulink url="https://github.com/macports/macports-guide">the macports-guide repository on GitHub</ulink> and press the <userinput>Fork</userinput> button in the
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- upper right corner. This will create a macports-guide repository in your own GitHub
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- account. Add your new repository as a remote to your local repository, rebase your
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- changes on top of the current upstream master and push the result to your new
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- repository on GitHub.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <programlisting><prompt>$</prompt> <userinput>git remote add <username> https://github.com/<username>/macports-guide.git</userinput>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-<!-- --><prompt>$</prompt> <userinput>git pull --rebase</userinput>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-<!-- --><prompt>$</prompt> <userinput>git push <username> my-changes</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- From here on, follow the GitHub documentation on <ulink url="https://help.github.com/articles/creating-a-pull-request/">
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- how to create a pull request</ulink>.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </listitem>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </orderedlist>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>git pull --rebase</userinput>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+<prompt>$</prompt> <userinput>git push <replaceable>username</replaceable> my-changes</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </step>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </procedure>
</span> </section>
</section>
</section>
</pre><pre style='margin:0'>
</pre>