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

Simplifies integration docs #13926

Merged
merged 4 commits into from
Jun 12, 2024
Merged

Simplifies integration docs #13926

merged 4 commits into from
Jun 12, 2024

Conversation

discdiver
Copy link
Contributor

@discdiver discdiver commented Jun 11, 2024

  • Fixes minor build errors that already existed
  • Links to SDK docs for each Prefect integration library
  • Simplifies navigation
  • Improves IA of integrations home page

Closes 13927
Closes 13928

Still to do in other PRs:

  1. Create integration library images section with existing script to show Prefect-maintained and third-party images with links.
  2. In contributing section, could improve example of creating a custom block or point elsewhere to show the user how to do that.

Example

Screenshot 2024-06-11 at 1 21 33 PM

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • If this pull request adds new functionality, it includes unit tests that cover the changes
  • This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.

For documentation changes:

  • This pull request includes redirect settings in mint.json for files that are removed or renamed.

For new functions or classes in the Python SDK:

  • This pull request includes helpful docstrings.
  • If a new Python file was added, this pull request contains a stub page in the Python SDK docs and an entry in docs/mint.json navigation.

@discdiver discdiver added the docs label Jun 11, 2024
@discdiver discdiver marked this pull request as ready for review June 11, 2024 17:21
@discdiver discdiver requested a review from a team as a code owner June 11, 2024 17:22
Copy link
Contributor

@billpalombi billpalombi left a comment

Choose a reason for hiding this comment

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

Great stuff!

@discdiver discdiver merged commit 661ebf0 into main Jun 12, 2024
4 checks passed
@discdiver discdiver deleted the testing branch June 12, 2024 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Combine integration docs sections Update mint.json nav for integration sdk docs
2 participants