Skip to content

[Documentation] OGC Documentation Enhancements #274

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

Closed
LucaCinquini opened this issue Jan 21, 2025 · 1 comment
Closed

[Documentation] OGC Documentation Enhancements #274

LucaCinquini opened this issue Jan 21, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation U-SPS

Comments

@LucaCinquini
Copy link
Collaborator

LucaCinquini commented Jan 21, 2025

PM Ticket Reference: unity-sds/unity-project-management#208

Description:

-Documentation on assumptions/requirement of Airflow DAG input parameters
-Best Practices
-Reference the existing OGC API notebook to gitbook? Need to capture detailed explanations on what we have in this notebook (https://github.com/unity-sds/unity-monorepo/blob/156153922a00d38fc0c8486a79a7627916d51c30/libs/unity-py/notebooks/ogc_notebook.ipynb)

Acceptance Criteria:

  • Overview of OGC Processing: Provide an overview of the OGC processing, including the OGC standard/specification.

  • Best Practices: Document best practices for using the Airflow OGC API and DAG effectively, and highlight common user confusions or mistakes. (future) Consider including best practices for writing DAGs for capturing airflow processing metrics.

  • Examples: Offer multiple examples demonstrating the OGC processing in various scenarios, with step-by-step procedures and accompanying screenshots or diagrams where applicable. Reference the existing OGC API notebook. (Drew already put together notebooks and request ASIPS review for what's missing)

@LucaCinquini LucaCinquini added the documentation Improvements or additions to documentation label Jan 21, 2025
@LucaCinquini LucaCinquini moved this from Todo to In Progress in Unity Project Board Jan 29, 2025
@LucaCinquini
Copy link
Collaborator Author

See sub-tickets, task complete

@github-project-automation github-project-automation bot moved this from In Progress to Done in Unity Project Board Feb 3, 2025
@LucaCinquini LucaCinquini moved this from Done to Todo in Unity Project Board Feb 3, 2025
@LucaCinquini LucaCinquini moved this from Todo to Done in Unity Project Board Feb 3, 2025
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 U-SPS
Projects
Status: Done
Development

No branches or pull requests

3 participants