Open crisaless opened 6 years ago
To clarify, this will help indicate separate guides better in the master site's sidebar navigation
Hmm, not sure what to do with hatrac...
HOWTO.md
seems like it is mostly a cheat sheet for the full REST-API.md
except a tiny bit of cheat sheet about config and authentication for test environments. Not sure we should expose this, as users should perhaps be looking at deriva-py and other CLI tools rather than looking here?INSTALL.md
then there aren't any user docs at all. Just the REST API.I just noticed that index.rst
seems to lower-case the filenames. Does the doc-builder apply some sort of case-conversion or case-insensitvity to filenames when it builds? The source files are mixed case as I wrote them above...
if users don't really need the hatrac info then we don't really need the index.rst for that repo.
as for upper/lower-case - sphinx style guide says use lowercase.
@crisaless there are two components that are missing: ioboxd and ermresolve
@hongsudt Good point. We haven't been focusing on those components at all yet. I'll add them. Who are the "owners" ?
For each of the following repos - owners should look at index.rst and delete references to files that are for internal use only (ie, installing, testing, implementation)