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

Update docs site org to match updated product thinking #1174

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

josh-padnick
Copy link
Contributor

@josh-padnick josh-padnick commented Oct 5, 2023

This PR updates the docs site to match the latest product packaging thinking. See the Netlify preview to see the updated nav.

Before we can merge this, we need to:

  • Update the Landing Zone intro to reflect an independent product, versus being a "component" of DevOps Foundations
  • Make it explicit how to install the Landing Zone (versus implicitly relying on the user knowing to go to IaC Foundations under DevOps foundations)
  • Add a Patcher intro
  • Update the DevOps Foundations section to reflect more of a "consulting service" mindset
  • Update Gruntwork Library to mention the Library Reference and three "use cases" (AWS foundations, EKS & Running apps, Storing data)

For some of the other Grunts not in the loop, we've been updating our approach to product packaging based on the latest insights, but we haven't had a chance to share that internally yet. Eben, Sarah, Jim, and myself are all up to date, and we'll meet soon to review the conclusions. We should do that prior to merging this PR.

@netlify
Copy link

netlify bot commented Oct 5, 2023

Deploy Preview for pensive-meitner-faaeee ready!

Name Link
🔨 Latest commit 36b3344
🔍 Latest deploy log https://app.netlify.com/sites/pensive-meitner-faaeee/deploys/6529daad421b80000879832d
😎 Deploy Preview https://deploy-preview-1174--pensive-meitner-faaeee.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 configuration.

@ebeneliason
Copy link
Contributor

It looks like the docs build is broken here so we aren't getting a preview. @josh-padnick Do you have this working locally?

@josh-padnick
Copy link
Contributor Author

Yeah, it works locally. The issue is broken links:

7:10:06 PM: - On source page path = /foundations/overview/:
7:10:06 PM:    -> linking to ../landing-zone (resolved as: /foundations/landing-zone)
7:10:06 PM: 
7:10:06 PM: - On source page path = /foundations/pipelines/:
7:10:06 PM:    -> linking to ../../foundations/landing-zone (resolved as: /foundations/landing-zone)
7:10:06 PM: 
7:10:06 PM: - On source page path = /foundations/pipelines/aws-authentication:
7:10:06 PM:    -> linking to ../landing-zone (resolved as: /foundations/landing-zone)
7:10:06 PM:    -> linking to ../landing-zone/add-aws-account.md (resolved as: /foundations/landing-zone/add-aws-account.md)
7:10:06 PM:    -> linking to ../landing-zone/add-aws-account (resolved as: /foundations/landing-zone/add-aws-account)
7:10:06 PM: 
7:10:06 PM: - On source page path = /landing-zone/enable-control-tower:
7:10:06 PM:    -> linking to ../iac-foundations (resolved as: /iac-foundations)
7:10:06 PM: 
7:10:06 PM: - On source page path = /landing-zone/logging:
7:10:06 PM:    -> linking to ../../pipelines/overview/index.md (resolved as: /pipelines/overview/index.md)
7:10:06 PM: 
7:10:06 PM: - On source page path = /pipelines/security/audit-log:
7:10:06 PM:    -> linking to ../../foundations/landing-zone/logging.md (resolved as: /foundations/landing-zone/logging.md)

For whatever reason, Docusaurus doesn't check broken links locally but then fails the build if it finds any broken links. You could either run locally or fix the links and see the preview env.

@josh-padnick
Copy link
Contributor Author

Ok, I think I fixed the broken links. FYI, this may be the reason why link checking only fails for deployment previews but not in prod; not sure, though.

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