search

NASA-IMPACT / veda-docs

Documentation for the VEDA Project
https://nasa-impact.github.io/veda-docs
Apache License 2.0
7 stars 7 forks source link

Add docs for content contribution and tidy up table of contents #60

Closed j08lue closed 1 year ago

j08lue commented 1 year ago

We would like to consolidate the docs about content creation on the VEDA NASA instance and make it accessible to contributors who are often not developers, so a rendered docs page might be more accessible than Markdown docs in GitHub.

This PR is to copy over a general content creation guide from an Almanac page, which is until now the go-to location for this information.

In this context, the table of contents gets an overhaul to clarify and tidy up the content.

jsignell commented 1 year ago

Oh! Are the issues I found in https://github.com/NASA-IMPACT/veda-data/issues/3 not the real source of truth?

j08lue commented 1 year ago

Oh! Are the issues I found in NASA-IMPACT/veda-data#3 not the real source of truth?

To be honest, I had not seen these instructing issues in veda-backend (https://github.com/NASA-IMPACT/veda-backend/issues/28 and https://github.com/NASA-IMPACT/veda-backend/issues/29, specifically). Sure, that must be our best reference for STAC conventions. The docs I am copying over here cover the overall flow of getting content into the Dashboard.

This only confirms, to me, that we need to consolidate all these great resources in one place, so it is easy to get an overview of the existing resources for contributors. The rule of thumb would be that all docs that our users (including content contributors) need to see that are specific to our project (conventions, processes), should be publicly discoverable. Everything specific to a piece of software (deployment instructions, API docs, etc) would live with that code base. Where necessary, we can link from service docs to software docs.

Would you agree that these docs could have a good place in the veda-docs, perhaps under a dedicated section, @jsignell?

jsignell commented 1 year ago

Would you agree that these docs could have a good place in the veda-docs, perhaps under a dedicated section, @jsignell?

Yes I definitely agree. We already have information about how to add notebooks, so this would just be an additional section about how to add datasets basically.