Changes between Initial Version and Version 1 of GCI/Documentation/BuildRTEMSDocumentation

Timestamp:

10/24/18 15:52:44 (6 years ago)

Author:

Joel Sherrill

Comment:

--

GCI/Documentation/BuildRTEMSDocumentation

@@ +1 @@
+= Build RTEMS Documentation =
+
+[[TOC(GCI/Documentation/BuildRTEMSDocumentation, depth=2)]]
+
+The RTEMS Documentation Suite viewable at https://docs.rtems.org is built using the [https://sphinx-doc.org/ Sphinx] toolset which supports the [http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html reStructuredText] mark up format. The source for the RTEMS Documentation is maintained in git just like the RTEMS Source Code. 
+
+== Task Description ==
+
+Download the source code for the RTEMS documentation by using git clone as follows:
+
+{{
+git clone git://git.rtems.org/rtems-docs.git
+}}
+
+Follow the instructions in the file README.txt in the top of the source tree. It provides guidance on installing the needed tools on various host operating systems. It does not include guidance for as many hosts as the instructions for building RTEMS do. A critical part of this task is helping the RTEMS Project improve these instructions.
+
+Another purpose of this task is to enable you to be able to modify the documentation in subsequent tasks and submit changes. The [wiki:GCI/Coding/HelloWorld] task includes guidance on using git that will be helpful here.
+
+Edit a page in the Users Guide and produce a PDF file of that document. Submit that PDF along with a patch as proof.
+
+== Feedback ==
+
+||'''Student Nickname''' || '''Host OS''' || '''Feedback'''
+|| NAME || HOST || TBD ||
+
+== Directions for Mentors ==
+Verify the patch, screenshot, and read the feedback above.
+
+Please file tickets when a host's instructions need updating for packages.
+
+
+