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

Propose navigation updates #16718

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

olearycrew
Copy link
Contributor

Proposing to make the following changes to streamline the left hand nav of the docs and make it a little more compact:

  • Reorder the top items to make the Quickstart more prominent and "what's new" less
  • Move "Test Workflows" under "write and run workflows" to not have it be a top-level item
  • Change "Run flows on dynamic infrastructure" to "Run on dynamic infrastructure" so that it fits on one line in the menu. Ideally, the "flows" in the sentence above and the pages themselves clear up any confusion that this simpler title may create.
  • Move all the "Events" related items to a group to decrease the number of items in the left-hand side by 3
  • Change Migrate from a top-level group to a smaller group under "Operate" to decrease the prominence of it.

I propose @daniel-prefect reviews this to agree or disagree with any/all of these changes

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
  • If this pull request removes docs files, it includes redirect settings in mint.json.
  • If this pull request adds functions or classes, it includes helpful docstrings.

@olearycrew
Copy link
Contributor Author

cc @discdiver for review as well

"v3/get-started/install",
"v3/get-started/quickstart"
Copy link
Contributor

Choose a reason for hiding this comment

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

I recently merged a PR to move the quickstart to the end of this group so that the schedule tutorial shows up next in the logical flow. I think that makes more sense than having the installation page follow.

#16705

@@ -169,18 +169,12 @@
"version": "v3"
},
{
"group": "Dynamic infrastructure examples",
"group": "Infrastructure examples",
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm okay with merging the two groups, but if we're going to do this we should also collapse the /v3/deploy/infrastructure-examples and v3/deploy/static-infrastructure-examples folders.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh wait I meant to do that...

Comment on lines +239 to 240
"v3/resources/upgrade-to-prefect-3",
"v3/resources/upgrade-agents-to-workers"
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm okay with nixing the top-level Migrate section, but I'd argue that the Prefect 3.0 upgrade guide belongs under Develop (since it's more code focused) and the upgrade agents to workers guide belongs under Operate (since it's more infra focused).

@discdiver
Copy link
Contributor

I like the idea of simplifying the top-level nav. Would be interested to see a preview deployment, but that's not building because of the conflicts in mint.json.

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.

3 participants