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

Moved API doc to top level, removed ref section and faqs #867

Merged
merged 2 commits into from
Nov 28, 2021
Merged

Moved API doc to top level, removed ref section and faqs #867

merged 2 commits into from
Nov 28, 2021

Conversation

chrisnegus
Copy link
Member

1. Issue, if available:

2. Description of changes:
This PR:

  • Remove the FAQs section of the docs.
  • Moves the "Provisioner CRD" section it up a level in the left nav and renames it "Provisioner API".
  • Deletes the now-empty Reference section and associated _index file.

Much of the FAQs was outdated or already covered somewhere else. I've gone through it and will add some of that content back into other parts of the docs.

3. Does this change impact docs?

  • Yes, PR includes docs updates
  • Yes, issue opened: link to issue
  • No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@netlify
Copy link

netlify bot commented Nov 27, 2021

✔️ Deploy Preview for karpenter-docs-prod ready!

🔨 Explore the source changes: b0272da

🔍 Inspect the deploy log: https://app.netlify.com/sites/karpenter-docs-prod/deploys/61a2d0b4720c2400086c89e3

😎 Browse the preview: https://deploy-preview-867--karpenter-docs-prod.netlify.app

Copy link
Contributor

@geoffcline geoffcline left a comment

Choose a reason for hiding this comment

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

it looks like there is one broken link due to the moved provisioner page

5:22:03 PM: ERROR 2021/11/27 23:22:03 [en] REF_NOT_FOUND: Ref "../../reference/provisioner-crd.md": "/opt/build/repo/website/content/en/pre-docs/cloud-providers/AWS/aws-spec-fields.md:7:23": page not found

can you fix this chris? The link should be

The [Provisioner CRD]({{< ref "../../provisioner-crd.md" >}}) supports defining

@chrisnegus
Copy link
Member Author

it looks like there is one broken link due to the moved provisioner page

5:22:03 PM: ERROR 2021/11/27 23:22:03 [en] REF_NOT_FOUND: Ref "../../reference/provisioner-crd.md": "/opt/build/repo/website/content/en/pre-docs/cloud-providers/AWS/aws-spec-fields.md:7:23": page not found

can you fix this chris? The link should be

The [Provisioner CRD]({{< ref "../../provisioner-crd.md" >}}) supports defining

Yes. I can do that.

@chrisnegus
Copy link
Member Author

/assign

The [Provisioner CRD]({{< ref "../../reference/provisioner-crd.md" >}}) supports defining
The [Provisioner CRD]({{< ref "../../provisioner-crd.md" >}}) supports defining
Copy link
Contributor

Choose a reason for hiding this comment

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

perfect!

@geoffcline geoffcline merged commit 06435dd into aws:main Nov 28, 2021
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