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

Remove knowledge base section #755

Merged
merged 12 commits into from
Apr 22, 2024
Merged

Conversation

plumbis
Copy link
Collaborator

@plumbis plumbis commented Apr 15, 2024

Related discussion in #749.

  • Removes the home landing page and sends users directly to the /latest version. - https://deploy-preview-755--crossplane.netlify.app/
  • Removes the /knowledge-base section and reorganizes pages into /concepts, /guides (new), or /learn (new) sections.
  • Implements Netlify redirects for all /knowledge-base/* paths
  • Adjusts page weights in v1.15 and master for section and page sorting in the left-side navigation.

Below is a list of all KB pages to verify their redirects inside Netlify.

I've also manually searched all pages to find KB and docs.crossplane links and update them. We're passing hugo build and the htmltest CI check, so I feel confident we've covered all existing KB links.

Verified redirects:
https://deploy-preview-755--crossplane.netlify.app/knowledge-base
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/disaster-recovery/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/connection-details/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/write-a-composition-function-in-go/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/write-a-composition-function-in-python/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/import-existing-resources/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/multi-tenant/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/self-signed-ca-certs/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/troubleshoot/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/learn-more/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/release-cycle/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/feature-lifecycle/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/composition-revisions-example/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/guides/composition-revisions/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/integrations/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/integrations/vault-as-secret-store/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/integrations/vault-injection/
https://deploy-preview-755--crossplane.netlify.app/knowledge-base/integrations/argo-cd-crossplane/

Copy link

netlify bot commented Apr 15, 2024

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit 71259ef
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/6626b2b77fc3730008ca4c2e
😎 Deploy Preview https://deploy-preview-755--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 82 (🔴 down 8 from production)
Accessibility: 90 (🔴 down 1 from production)
Best Practices: 83 (no change from production)
SEO: 93 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

@plumbis plumbis marked this pull request as ready for review April 16, 2024 14:58
Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

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

clicked through basically everything (including all the redirects) and this is looking good to me! I think it's a much more cohesive navigation experience to keep the left hand navigation pane mostly static. Really like this improvement!! 🙇‍♂️

# Moved KB article. See issue #749
from = "/knowledge-base/guides/composition-revisions"
to = "/latest/concepts/composition-revisions/"
status = 301
Copy link
Member

Choose a reason for hiding this comment

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

301 redirects sound like the right thing to do here, e.g. permanent redirect, but did want to call out that the previous pattern had been 302. Not sure if that divergence was intentional, but 301 does sound correct to me here.

Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
@plumbis plumbis merged commit 2b598cb into crossplane:master Apr 22, 2024
6 of 7 checks passed
@plumbis plumbis deleted the kb-reorg-749 branch April 22, 2024 19:44
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