You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
3.6 KiB
XML
62 lines
3.6 KiB
XML
<section version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_template_getting_started">
|
|
|
|
<title>Getting started</title>
|
|
<para>To begin contributing to the OpenPOWER Foundation documentation, the following steps must be completed:
|
|
<orderedlist>
|
|
<listitem>
|
|
<para>Install tools</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Create accounts</para>
|
|
</listitem>
|
|
</orderedlist>
|
|
</para>
|
|
|
|
<para>Once complete, you can proceed to either <xref linkend="section_template_new_document"/> or
|
|
<xref linkend="section_template_existing_document"/> as needed.</para>
|
|
|
|
<section>
|
|
<title>Installing tools</title>
|
|
<para>Only two tools are required to update documentation, git and maven. Git manages the documentation
|
|
source and maven provides the build framework to create the published content in PDF and html form.
|
|
Installation steps for these tools varies by operating system.</para>
|
|
<para>On Debian-based Linux operating systems (Ubuntu and Debian), install maven and git as follows:
|
|
<screen><prompt>$</prompt><userinput>sudo apt-get install git</userinput>
|
|
<prompt>$</prompt><userinput>sudo apt-get install maven</userinput></screen></para>
|
|
<para>On RPM-based Linux operating systems (Fedora, RHEL, openSUSE, SLES), install maven and git as follows:
|
|
<screen><prompt>$</prompt><userinput>sudo yum install git</userinput>
|
|
<prompt>$</prompt><userinput>sudo yum install maven</userinput></screen></para>
|
|
<para>On Mac OS X, use Macports to install maven and git as follows:
|
|
<screen><prompt>$</prompt><userinput>sudo port install git</userinput>
|
|
<prompt>$</prompt><userinput>sudo port install maven3</userinput></screen></para>
|
|
<para>or use Homebrew to install maven and git as follows:
|
|
<screen><prompt>$</prompt><userinput>brew install git</userinput>
|
|
<prompt>$</prompt><userinput>brew install maven</userinput></screen></para>
|
|
<para>For information on how to setup the environment on Windows, see the following websites:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>git for Windows - <link xlink:href="http://msysgit.github.io/">http://msysgit.github.io/</link></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Maven on Windows - <link xlink:href="http://maven.apache.org/guides/getting-started/windows-prerequisites.html">
|
|
http://maven.apache.org/guides/getting-started/windows-prerequisites.html</link></para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Creating accounts</title>
|
|
<para>All OpenPOWER project documentation is maintained in GitHub trees, public and private. To join the GitHub community,
|
|
apply at <link xlink:href="https://github.com/join">https://github.com/join</link>.</para>
|
|
<para>If you will be participating in private OpenPOWER Foundation trees, you will need to visit the OpenPOWER Foundation Members
|
|
Area wiki to find administrators for the appropriate git tree.</para>
|
|
<para>To learn more about using git, see the online article in GitHub Help, "Good Resources for Learning Git and GitHub." at
|
|
<link xlink:href="https://help.github.com/articles/good-resources-for-learning-git-and-github/">
|
|
https://help.github.com/articles/good-resources-for-learning-git-and-github/</link>.</para>
|
|
</section>
|
|
|
|
</section>
|
|
|