-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for content contribution and tidy up table of contents #60
Conversation
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 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 |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it!
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.