Difference between revisions of "Resources/Documentation"

From AtoM wiki
(Add basic page content)
m (Documenation contribution guidelines: fix other link typo)
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Main Page]] > [[Resources]] > Resources/Documentation
 
[[Main Page]] > [[Resources]] > Resources/Documentation
  
<admonition type="warning">
+
On this page you'll find some information about our [https://www.accesstomemory.org/docs/ user documentation], including the User and Administrator Manuals found on our website for each major AtoM release.
This page is under construction! It is being moved to the wiki for easier long-term maintenance. For now, you can view a version of the original document at:
+
 
* https://github.com/artefactual/atom-docs/blob/about-contribute/index.rst
+
<admonition type="seealso">
 +
* [[Development/Contribute code|Contribute code]]
 +
* [[Resources/Translation|Contribute translations]]
 
</admonition>
 
</admonition>
  
On this page you'll find some information about our [https://www.accesstomemory.org/docs/ user documentation], including the User and Administrator Manuals found on our website for each major AtoM release.
 
  
 
===[[Resources/Documentation/About|About our documentation]]===
 
===[[Resources/Documentation/About|About our documentation]]===
Line 14: Line 15:
  
 
* [[Resources/Documentation/About|About our documentation]]
 
* [[Resources/Documentation/About|About our documentation]]
 +
  
 
===[[Resources/Documentation/Contribute|How to contribute to our documentation]]===
 
===[[Resources/Documentation/Contribute|How to contribute to our documentation]]===
Line 20: Line 22:
  
 
* [[Resources/Documentation/Contribute|How to contribute to our documentation]]
 
* [[Resources/Documentation/Contribute|How to contribute to our documentation]]
 +
 +
 +
===[[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]]===
 +
 +
A tutorial and style guide on some of the best practices we encourage when working with our documentation. Please check this out before contributing documentation!
 +
 +
* [[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]]
 +
 +
 +
  
 
[[Category:Resources]]
 
[[Category:Resources]]
  
 
__NOTOC__
 
__NOTOC__

Latest revision as of 16:47, 26 June 2015

Main Page > Resources > Resources/Documentation

On this page you'll find some information about our user documentation, including the User and Administrator Manuals found on our website for each major AtoM release.

About our documentation

Information on why we have chosen the Sphinx documentation platform to create our User and Administrator manuals

How to contribute to our documentation

Basic instructions on the ways, both large and small, that you can help us maintain our project documentation!

Documentation contribution guidelines

A tutorial and style guide on some of the best practices we encourage when working with our documentation. Please check this out before contributing documentation!