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: sidebar restructure #644

Merged
merged 15 commits into from
May 31, 2023
Merged

Docs: sidebar restructure #644

merged 15 commits into from
May 31, 2023

Conversation

ZPain8464
Copy link
Contributor

This PR replaces /docs/releases with /docs/deploy. The Deploy sidebar houses the following sections:

  • Pomerium Core
  • Kubernetes
  • Enterprise

@ZPain8464 ZPain8464 requested review from wasaga and desimone May 26, 2023 15:41
@ZPain8464 ZPain8464 requested a review from a team as a code owner May 26, 2023 15:41
@ZPain8464 ZPain8464 requested review from cmo-pomerium and removed request for a team May 26, 2023 15:41
@netlify
Copy link

netlify bot commented May 26, 2023

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit 809b79f
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/64763fbc2a66f700076a9b3c
😎 Deploy Preview https://deploy-preview-644--pomerium-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ZPain8464
Copy link
Contributor Author

The redirects file would need to updated as well. But I think it might be easier to merge this (if everyone is happy with it so far) and fix breaking links as they appear. (Similar to the last big re-org).

Copy link
Collaborator

@desimone desimone left a comment

Choose a reason for hiding this comment

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

Overall, I think this is a good change.

  • I think we should move “Clients” from under “Pomerium core” to being under “Deploy” at the bottom of the list.
  • Move “To production” from Enterprise to under Deploy and move it to the very bottom of the list.

Otherwise, LGTM pending … yeah, that’s going to be a lot of redirects. :/

@ZPain8464 ZPain8464 requested a review from desimone May 30, 2023 14:58
@@ -336,7 +336,7 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co
# flattened the changelog, and upgrading guide
/docs/overview/upgrading/archive /docs/overview/upgrading
/docs/overview/changelog/archive /docs/overview/upgrading
/docs/overview/upgrading /docs/releases/upgrading
/docs/overview/upgrading /docs/deploy/core/upgrading
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we set a catch all for /deploying/* and /releases/*?

@ZPain8464 ZPain8464 merged commit a94e5e5 into main May 31, 2023
5 checks passed
@ZPain8464 ZPain8464 deleted the zpain/sidebar-restructure branch May 31, 2023 14:07
@backport-actions-token
Copy link

The backport to 0-22-0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-0-22-0 0-22-0
# Navigate to the new working tree
cd .worktrees/backport-0-22-0
# Create a new branch
git switch --create backport-644-to-0-22-0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 a94e5e54c90158ea7caf65c8001671b5733510b2
# Push it to GitHub
git push --set-upstream origin backport-644-to-0-22-0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-0-22-0

Then, create a pull request where the base branch is 0-22-0 and the compare/head branch is backport-644-to-0-22-0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants