Improved user operation and installation guides with github pages

NASA-PDS / deep-archive

PDS Open Archival Information System (OAIS) utilities, including Submission Information Package (SIP) and Archive Information Package (AIP) generators

https://nasa-pds.github.io/deep-archive/

Other

7 stars 4 forks source link

Improved user operation and installation guides with github pages #1

Closed jordanpadams closed 4 years ago

jordanpadams commented 4 years ago

This task is to generate github pages for the user guide using favorite Python docs generator.

[x] Deploy pds-deep-archive to pypi for easy install
[x] Dependencies/Assumptions - e.g. python3 must be installed
[x] Installation Guide - let's start with buildout instructions then have alternative instructions using virtualenv since most of our users will not be able to do that
[x] Operation Guide - very basic "this is how you run it" with an output of -h

nutjob4life commented 4 years ago

Ugh, a new issue already? I regret moving this over now! 😅

I tease, I tease.

jordanpadams commented 4 years ago

@nutjob4life if you makes you feel any better, this is a copy-paste from the internal repo 🎉