search

ucsd-ccbb / qiimp

Web application to collect metadata specifications from an experimenter and produce metadata input files with appropriate constraints
3 stars 7 forks source link

Add webhook to read the docs documentation #100

Closed adswafford closed 6 years ago

adswafford commented 6 years ago

https://readthedocs.org/api/v2/webhook/metadata-wizard-tutorial/25102/

http://metadata-wizard-tutorial.readthedocs.io/en/latest/

AmandaBirmingham commented 6 years ago

Where do you want these links to go? README? Interface? Both? If in interface, do you have thoughts about where/how you want these links represented on the screen?

adswafford commented 6 years ago

Both on the main screen at the top so users can see it before they use it: "Need help? Visit the tutorial here: [link]" and on the template download page

AmandaBirmingham commented 6 years ago

I have set up a webhook for this repository to the readthedocs.org/api/ url given above, which states it is a webhook, following the instructions at https://read-the-docs.readthedocs.io/en/latest/webhooks.html#github . See https://github.com/ucsd-ccbb/cmi_metadata_wizard/settings/hooks for confirmation.

@adswafford However, note that since the current readthedocs documentation is static, and not being generated from the source code, this webhook integration won't actually cause any changes to the documentation!