Skip to content

Improve documentation structure for plugins and cookbook - #1647

Open
alstondsouza1 wants to merge 4 commits into
apache:mainfrom
alstondsouza1:docs-1043-structure
Open

alstondsouza1 wants to merge 4 commits into
apache:mainfrom
alstondsouza1:docs-1043-structure

Conversation

@alstondsouza1

@alstondsouza1 alstondsouza1 commented Jun 22, 2026 •

Copy link
Copy Markdown

Summary

This PR addresses #1043 by improving the organization of the documentation.

Changes

  • Split the old Integrations section into Plugins and Cookbook sections.
  • Added a Plugin API Reference section.
  • Kept lifecycle interfaces under the Lifecycle API section.
  • Moved concrete adapters such as ProgressBar and SlackNotifier into the plugin reference.
  • Updated navigation and internal links that referenced the old paths.
  • Updated example README links.

Testing

  • Verified moved pages and toctree targets exist.
  • Checked for stale references to old documentation paths.
  • Ran git diff --check.
  • Full Sphinx documentation build will be performed through CI.

Closes #1043.

@skrawcz

skrawcz commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

@alstondsouza1 thanks for putting this up. sorry for the slow review. mind resolving the conflict?

@alstondsouza1

Copy link
Copy Markdown
Author

Thanks for reviewing! I've merged the latest main and resolved the conflicts, preserving the upstream updates in the relocated FastAPI and OpenLineage documentation pages. I also updated the new materialization link to the relocated OpenLineage page.

Verified all 161 documentation navigation targets and ran git diff --check. A full Sphinx build wasn't run locally because Sphinx isn't installed. GitHub now reports the branch as mergeable. Ready for another review.

This branch has not been deployed

No deployments
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.

Improving documentation structure

2 participants