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

Instance management docs #190

Open
j08lue opened this issue Dec 9, 2024 · 1 comment
Open

Instance management docs #190

j08lue opened this issue Dec 9, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@j08lue
Copy link
Contributor

j08lue commented Dec 9, 2024

I see we merged this PR that introduced a third section in the docs, called "Managing your Own VEDA":

I guess your goal with this new section, @aboydnw, is to have docs for platform content management that are universal to all instances, correct?

Right now those docs are still quite specific to the VEDA EarthData instance and our VEDA project team:

  1. Adding Content lists the VEDA EarthData endpoints and repos and refers to the conventions we established.
  2. All Usage Examples refer to datasets in VEDA EarthData catalogs and the thematic context of the EarthData instance.

I would in principle expect platform instance teams to create their own docs (internal or public), listing their content conventions and review processes, and for technical details referencing software usage and API docs that live with the software.

Do we really need this new section? If we do, do we need to adjust our content to better fit this model?

@j08lue j08lue added the documentation Improvements or additions to documentation label Dec 9, 2024
@j08lue j08lue mentioned this issue Dec 9, 2024
2 tasks
@aboydnw
Copy link
Contributor

aboydnw commented Dec 9, 2024

I would in principle expect platform instance teams to create their own docs (internal or public), listing their content conventions and review processes, and for technical details referencing software usage and API docs that live with the software.

This only seems reasonable for a) large projects like GHG or b) projects/programs totally unrelated to NASA & VEDA. Both of which I would say seem to be outliers in the near future. And in any case, we probably need some overarching VEDA documentation on "so, you want an instance, eh?" that lives outside of any single repo.

The idea behind the section is that somebody coming to docs has a few different questions they might be trying to answer:

  1. What is this VEDA thing? (NASA VEDA Platform)
  2. How do I use it? (Managing your Own VEDA)
  3. What if something is missing or I want to contribute to it? (VEDA Open Source Ecosystem)

Each of those would represent scaling up in terms of level of involvement / technical expertise. Somebody trying to understand it probably already knows what it is and why it is valuable, but maybe is not interested in creating a PR to add functionality to the core code, for example.

So, in my opinion, we do need the section, and also need to adjust the content. I started doing that a little bit with some dashboard content, like referencing Earthdata instance things as examples, but we need more changes for sure. I don't know if it means we have to go back to the drawing board on the content and examples, we might just have to position them as examples or something like that.

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants