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

Various website updates #1169

Merged
merged 5 commits into from
Jan 23, 2023
Merged

Conversation

SgtCoDFish
Copy link
Member

See individual commit messages for details.

#1168 describes how even after this PR, API docs are still broken - but this PR should still improve the situation by removing invalid HTML from the sidebar

this was safe previously, but we added more files to reference which
means that `docs/` always gets clobbered by whatever's been created for
the latest version

Signed-off-by: Ashley Davis <[email protected]>
@jetstack-bot jetstack-bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 20, 2023
when a Dropdown element was embedded in another Dropdown element, a
<div> tag would appear as a direct descendent of a <ul> which is
invalid (since only <li> are allowed to appear in <ul>)

this change embeds the dropdown in an <li> which seems to work fine in
testing and fixes the invalid HTML

Signed-off-by: Ashley Davis <[email protected]>
Listbox (see https://headlessui.com/react/listbox) provides certain form
elements for use, which get translated into normal HTML elements

it's illegal for a <label> to appear inside a <button>, so this commit
removes the label entirely which seems to have no visible effects and
fixes the invalid HTML that was otherwise generated

Signed-off-by: Ashley Davis <[email protected]>
@netlify
Copy link

netlify bot commented Jan 20, 2023

Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit 2a4094c
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/63cae8ab1f8488000a622776
😎 Deploy Preview https://deploy-preview-1169--cert-manager-website.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.

@netlify
Copy link

netlify bot commented Jan 20, 2023

Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit 9b67fc5
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/63ce596cca625c00088681fe
😎 Deploy Preview https://deploy-preview-1169--cert-manager-website.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.

components/docs/Sidebar/Dropdown.jsx Show resolved Hide resolved
components/docs/VersionSelect.jsx Show resolved Hide resolved
content/docs/cli/controller.md Show resolved Hide resolved
content/docs/reference/api-docs.md Show resolved Hide resolved
content/docs/reference/api-docs.md Show resolved Hide resolved
content/docs/reference/api-docs.md Show resolved Hide resolved
content/v1.11-docs/reference/cmctl.md Show resolved Hide resolved
scripts/gendocs/generate-new-import-path-docs Show resolved Hide resolved
scripts/gendocs/templates/members.tpl Show resolved Hide resolved
v1.11 CLI docs, etc have more updates because their updates
weren't committed - they're regenerated at build time so the
deployed version was correct, but committing here makes the
repo better match reality

Signed-off-by: Ashley Davis <[email protected]>
@inteon
Copy link
Member

inteon commented Jan 23, 2023

Thank you for these fixes @SgtCoDFish!
/lgtm
/approve

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 23, 2023
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inteon, SgtCoDFish

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

<Dropdown
routes={r}
parentOpen={open}
key={`${r.title}-${idx}`}
Copy link
Member

@inteon inteon Jan 23, 2023

Choose a reason for hiding this comment

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

@SgtCoDFish
This key is now double (on this and the parent HTML tag), not sure if that is a good/ bad thing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I wasn't sure either 😂 But it worked fine for me in testing so I assumed it wouldn't be a huge problem!

@jetstack-bot jetstack-bot merged commit 895eade into cert-manager:master Jan 23, 2023
@SgtCoDFish SgtCoDFish deleted the apirefgen branch January 23, 2023 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants