search

spacepy / dbprocessing

Automated processing controller for heliophysics data
5 stars 4 forks source link

Link github page in documentation #118

Closed jtniehof closed 2 years ago

jtniehof commented 2 years ago

The dbprocessing documentation doesn't make a very obvious link to the github page. (I had to do some poking to find it, it's in the Contributing section of the developer information, but that's not obvious.) It's a good link to have for potential devs, but also of course for how to get help. There's also a github setting for "how we suggest you get help" that should be set up.

Proposed enhancement

The SpacePy docs have a link right in the header to the github page, labeled "development." This might be a way to go...potentially add a "help" link to a place in the docs in the header as well.

Alternatives

Leave people confused :)

OS, Python version, and dependency version information:

Linux-4.15.0-166-generic-x86_64-with-Ubuntu-18.04-bionic
sys.version_info(major=2, minor=7, micro=17, releaselevel='final', serial=0)
sqlalchemy=1.1.11

Version of dbprocessing

Current github master (fb95a08ff01bf293a4a4059f331ad4860066ddb7)

Closure condition

PR merged with doc updates that clearly link the github page in a visible place (or everywhere), provide a basic "help" page, and documents any github configuration changes (which must also be implemented).

I don't think we need to update https://spacepy.github.io/dbprocessing to close this, provided we update that with every release.