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

Docs: promoting to production #162

Merged
merged 10 commits into from
Aug 20, 2024
Merged

Docs: promoting to production #162

merged 10 commits into from
Aug 20, 2024

Conversation

anayeaye
Copy link
Contributor

@anayeaye anayeaye commented Aug 13, 2024

What

This is phase one of upgrading our ingestion documentation. The goal is to update the veda-docs/contributing pages with current links and examples. More changes for automation are planned soon (#161) but should hopefully only require a small update to the README. https://github.com/NASA-IMPACT/veda-data/pull/162/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R149

NOTE I moved the geoglam ingestion example to veda-docs. The README link to this notebook should be confirmed after the corresponding veda-docs PR is merged (NASA-IMPACT/veda-docs#161)

@anayeaye anayeaye marked this pull request as draft August 13, 2024 21:29
@@ -76,10 +76,15 @@
"source": [
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should this notebook be moved to veda-docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

Agree that this should move to veda-docs

@anayeaye anayeaye marked this pull request as ready for review August 14, 2024 19:05
@anayeaye anayeaye changed the title Docs: promoting to production [WIP] Docs: promoting to production Aug 14, 2024
```

</details>

## Validation
Copy link
Contributor

@smohiudd smohiudd Aug 15, 2024

Choose a reason for hiding this comment

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

@anayeaye as part of the validation should we also create json schema that includes our minimum requirements for collection metadata to maintain consistency across the production catalog? For example, all collections in VEDA must include:

  • providers
  • thumbnails assets
  • renders

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ooof I just included those there in an optional section in the updated geoglam notebook that is now runnable in the hub https://github.com/NASA-IMPACT/veda-docs/blob/c9dc33a8f2960fa29a59db2974f979b12055f8ca/contributing/dataset-ingestion/example-template/example-geoglam-ingest.ipynb

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't disagree on a firm nudge to create renders and thumbnails but I don't think we should require them until we have great docs on how to set them up + a way for users to upload thumbs (which are both doable)

@smohiudd smohiudd self-requested a review August 16, 2024 14:00
Copy link
Member

@botanical botanical left a comment

Choose a reason for hiding this comment

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

Nice diagram!

@anayeaye anayeaye merged commit 24b60ad into main Aug 20, 2024
2 checks passed
@anayeaye anayeaye deleted the docs/promoting-to-production branch August 20, 2024 19:14
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.

3 participants