Skip to content

Commit

Permalink
docs: Added rST sample document and other documentation tweaks. (w-a-…
Browse files Browse the repository at this point in the history
…r-m-inventory-system#187)

* fix: Various UI tweaks to make the system run correctly. (w-a-r-m-inventory-system#184)

* fix: Various UI tweaks to make the system run correctly. (w-a-r-m-inventory-system#185)

* docs: Added rST sample document and other documentation tweaks.

- Added Restructured Text Examples.rst of commonly used rST markup.
- Broke the User Documentation into four documents for easier editing.
-- By making it four documents, multiple people can edit separate documents
   while minimizing the number of git conflicts.
-- A side effect of this split is that each document will be shown on a
   separate web page.
  • Loading branch information
deeppunster committed May 8, 2020
1 parent fbe9406 commit 2619eee
Show file tree
Hide file tree
Showing 5 changed files with 541 additions and 15 deletions.
27 changes: 13 additions & 14 deletions docs/source/DeveloperDocumentation.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

.. _DeveloperDocumentation:
.. _Developer Documentation:

#######################
Developer Documentation
Expand All @@ -9,17 +8,17 @@ Developer Documentation
:maxdepth: 2
:caption: Developer Table of Contents:

UML Diagrams <UMLDiagrams>
UML Diagrams

Box Management <DevDocs/BoxManagement>
DevDocs/Box Management

Deployment Documentation <DevDocs/DeploymentDocumentation>
DevDocs/Deployment Documentation

Django and Nginx <DevDocs/DjangoAndNginx>
DevDocs/Django and Nginx

JavaScript And JQuery <DevDocs/JavaScriptAndJQuery>
DevDocs/JavaScriptAndJQuery

Outstanding Tasks <OutstandingTasks>
Outstanding Tasks

Getting Started
===============
Expand Down Expand Up @@ -54,7 +53,7 @@ The Django web framework code will be downloaded as part of the project code.
Starting Point
--------------

Please start with the :doc:`Git Guidelines <DevDocs/GitGuidelines>`.
Please start with the :doc:`Git Guidelines <DevDocs/Git Guidelines>`.


General Developer Documentation
Expand All @@ -69,22 +68,22 @@ Documentation about Django, including documentation specific to this project.

:doc:`Django <DevDocs/Django>`

:doc:`Django Guidelines <DevDocs/DjangoGuidelines>`
:doc:`Django Guidelines <DevDocs/Django Guidelines>`

PostgreSQL Documentation
========================

Documentation about PostgreSQL that is specific to this project.

:doc:`PostgreSQL Guidelines <DevDocs/PostgreSQLGuidelines>`
:doc:`PostgreSQL Guidelines <DevDocs/PostgreSQL Guidelines>`

Git Documentation
=================

Documentation about git (the source code control software) that is specific to
this project.

:doc:`Git Guidelines <DevDocs/GitGuidelines>`
:doc:`Git Guidelines <DevDocs/Git Guidelines>`

Internal Documentation
======================
Expand All @@ -95,13 +94,13 @@ Javascript and JQuery information specific to this project.

How information about boxes and their workflows.

:doc:`Box Management <DevDocs/BoxManagement>`
:doc:`Box Management <DevDocs/Box Management>`


Deployment Documentation
========================

This system is planned to be deployed in a "cloud" platform.
See :doc:`Deployment Documentation <DevDocs/DeploymentDocumentation>` for
See :doc:`Deployment Documentation <DevDocs/Deployment Documentation>` for
both an overview of the deployment plans and details as
they are implemented.
5 changes: 5 additions & 0 deletions docs/source/Individual Box Instructions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###########################
Individual Box Instructions
###########################

Describe how to manage individual boxes of product.
Loading

0 comments on commit 2619eee

Please sign in to comment.