Skip to content
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

Merged
merged 11 commits into from
Jun 5, 2023

Conversation

j08lue
Copy link
Contributor

@j08lue j08lue commented May 24, 2023

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
Copy link
Collaborator

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

@j08lue
Copy link
Contributor Author

j08lue commented May 26, 2023

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 (NASA-IMPACT/veda-backend#28 and NASA-IMPACT/veda-backend#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
Copy link
Collaborator

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.

@j08lue j08lue changed the title STUB - Add docs for content contribution Add docs for content contribution and tidy up table of contents Jun 5, 2023
@j08lue j08lue marked this pull request as ready for review June 5, 2023 14:06
@j08lue j08lue requested a review from jsignell June 5, 2023 14:06
Copy link
Collaborator

@jsignell jsignell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it!

@j08lue j08lue merged commit 948fc9e into main Jun 5, 2023
@j08lue j08lue deleted the contributing-dashboard-content-stub branch June 5, 2023 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants