<pre style='margin:0'>
Rainer Müller (raimue) pushed a commit to branch master
in repository macports-guide.
</pre>
<p><a href="https://github.com/macports/macports-guide/commit/e402d6252c9d04eda825d970af85ccf36724b8c0">https://github.com/macports/macports-guide/commit/e402d6252c9d04eda825d970af85ccf36724b8c0</a></p>
<pre style="white-space: pre; background: #F8F8F8"><span style='display:block; white-space:pre;color:#808000;'>commit e402d6252c9d04eda825d970af85ccf36724b8c0
</span>Author: Rainer Müller <raimue@macports.org>
AuthorDate: Sun Nov 13 16:06:27 2016 +0100
<span style='display:block; white-space:pre;color:#404040;'> Include documentation on how to update the guide
</span>---
guide/xml/project.xml | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 91 insertions(+)
<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 ecd6b06..809608a 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;'>@@ -974,6 +974,97 @@ To use the current port, you must be in a port's directory.</screen>
</span> </section>
</section>
<span style='display:block; white-space:pre;background:#e0ffe0;'>+ <section id="project.docs">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <title>Updating Documentation</title>
</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">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <title>Updating the Guide</title>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ 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:#e0ffe0;'>+ Git repository on 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 below.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </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.preparing-changes">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <title>Preparing Changes</title>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <orderedlist>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>First, clone the sources to your computer and switch to a new branch for your changes:</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>git clone https://github.com/macports/macports-guide.git</userinput>
</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 checkout -b my-changes origin/master</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Make your changes to the file in the <filename>guide/xml/</filename> directory that
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ corresponds to the section you want to make changes to.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>$EDITOR guide/xml/</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Verify your changes are still valid XML. First, install the required software from
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ MacPorts if you do not already have it installed. If the <command>make validate</command>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ command reports errors, fix the XML sources until you see no more error messages.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>sudo port install libxslt docbook-xsl</userinput>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+<!-- --><prompt>$</prompt> <userinput>make validate</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Convert the guide to HTML and view the new version in your browser.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>make guide</userinput>
</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;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Commit your changes to the local branch and describe your changes in the commit
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ 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:#e0ffe0;'>+ that explains how to write good commit messages.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting><prompt>$</prompt> <userinput>git commit -a</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </orderedlist>
</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.pull-request">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <title>Creating a Pull Request</title>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ 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:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <orderedlist>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ 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:#e0ffe0;'>+ upper right corner. This will create a macports-guide repository in your own GitHub
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ account. Add your new repository as a remote to your local repository, rebase your
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ changes on top of the current upstream master and push the result to your new
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ repository on GitHub.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <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:#e0ffe0;'>+<!-- --><prompt>$</prompt> <userinput>git pull --rebase</userinput>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+<!-- --><prompt>$</prompt> <userinput>git push <username> my-changes</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ 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:#e0ffe0;'>+ how to create a pull request</ulink>.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </listitem>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </orderedlist>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </section>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </section>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ </section>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span> <section id="project.membership">
<title>MacPorts Membership</title>
</pre><pre style='margin:0'>
</pre>