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 reset: remove Cloud section + tutorials, add recipe examples #610

Merged
merged 55 commits into from
Sep 29, 2023

Conversation

cisaacstern
Copy link
Member

This PR addresses item 2 of the tasks in #569 (comment):

Revert the nested hierarchy of the current docs (Pangeo Forge Recipes, and Pangeo Forge Cloud headings) in favor of making these docs "just" about pangeo-forge-recipes. The Cloud docs are now out-of-date, and doing this should make the final item easier, insofar as it impacts the overall narrative arc of the docs.

@rabernat
Copy link
Contributor

I would consider adding a placeholder high-level section on "Deploying Recipes" after "Advanced Examples," even if it is just TODO for now.

@cisaacstern
Copy link
Member Author

cisaacstern commented Sep 27, 2023

Getting close. Remaining TODO:

  • Cleanup composition/examples/index
  • [ ] Cleanup api_reference
  • Cleanup contributing
  • Flesh out deployment/cli

@cisaacstern
Copy link
Member Author

This is a big overhaul the main objectives of which included:

  • Remove obsolete Cloud docs
  • Replace difficult-to-maintain tutorials with integration-tested recipe examples
  • Restructure recipe docs to reflect Beam composition + current Deployment options

Additional wins here IMHO:

  • Upgrading Sphinx by 3️⃣ major versions! Thinks look so contemporary in Sphinx 6

Going to merge this because there's a lot in the current docs that is stale which I want to get off the public internet ASAP.

There is still much room for improving the new sections here, as well as adding additional sections. Let's follow up on that in additional Issues/PRs. I am totally open to rethinking these docs based on everyone's feedback, just don't want to delay getting some updated info out into the public.

Tagging @rabernat @norlandrhagen @derekocallaghan for visibility.

@cisaacstern cisaacstern merged commit 7e34030 into main Sep 29, 2023
6 checks passed
@cisaacstern cisaacstern deleted the docs-reset branch September 29, 2023 04:45
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.

None yet

2 participants