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.

Sign up for GitHub

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

Jump to bottom

Improve scrolling in API ref docs #43076

Merged
merged 1 commit into from
Sep 17, 2023
Merged

Improve scrolling in API ref docs #43076

merged 1 commit into from
Sep 17, 2023

Conversation

xrstf
Copy link
Contributor

@xrstf xrstf commented Sep 16, 2023 •
edited
Loading

This is the sister PR to kubernetes-sigs/reference-docs#334 -- the generated API docs will soon use the DOM exclusively for its navigation, making the navData.js redundant. To that end, the scroll-apiref.js had to be rewritten entirely.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 16, 2023
@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 16, 2023
@xrstf xrstf mentioned this pull request Sep 16, 2023
Merged
@netlify
Copy link

netlify bot commented Sep 16, 2023 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 0dc0a52
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6506a8db1416470008852a11
😎 Deploy Preview https://deploy-preview-43076--kubernetes-io-main-staging.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.

@tengqm
Copy link
Contributor

tengqm commented Sep 16, 2023

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 16, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4ed6d8e10a32fbd26a3e1f2e87c8a5f29b1163a4

Arhell
Arhell reviewed Sep 17, 2023
View reviewed changes
Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

lgtm

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 17, 2023
@xrstf
Copy link
Contributor Author

xrstf commented Sep 17, 2023

/hold

This is ready from my end (had to repush due to one stray var), but putting the PR on hold to coordinate when to merge it.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 17, 2023
@xrstf xrstf changed the title WIP - improve scrolling in API ref docs Improve scrolling in API ref docs Sep 17, 2023
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 17, 2023
@tengqm
Copy link
Contributor

tengqm commented Sep 17, 2023 •
edited
Loading

preview: https://deploy-preview-43076--kubernetes-io-main-staging.netlify.app/docs/reference/generated/kubernetes-api/v1.28/

Looks like the navigation bar is not sync'ed with the main page?
Em... smells like that the 'navData.js` was incorrectly located.
Let's get this fixed.

@xrstf
Copy link
Contributor Author

xrstf commented Sep 17, 2023

Yeah the 1.28 docs are missing the navData.js ( https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/ ), but I'm not sure if this PR should/can fix this?

@tengqm
Copy link
Contributor

tengqm commented Sep 17, 2023

Yeah the 1.28 docs are missing the navData.js ( https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/ ), but I'm not sure if this PR should/can fix this?

Okay. We can leave that to another PR, i.e. regenerate the HTML and remove the JS.

@xrstf
Copy link
Contributor Author

xrstf commented Sep 17, 2023

/hold cancel

I guess this would be ready to get merged.

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 17, 2023
@tengqm
Copy link
Contributor

tengqm commented Sep 17, 2023

Thanks.
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 17, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 92b2b0a0b19c69df13a10cae0fad0243f060726d

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 17, 2023
@k8s-ci-robot k8s-ci-robot merged commit fdb1bda into kubernetes:main Sep 17, 2023
4 checks passed
@xrstf xrstf deleted the improve-apidocs-scrolling branch September 17, 2023 09:53
@xrstf xrstf mentioned this pull request Apr 4, 2024
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Arhell Arhell Arhell left review comments

@kbhawkey kbhawkey Awaiting requested review from kbhawkey

@onlydole onlydole Awaiting requested review from onlydole

@tengqm tengqm Awaiting requested review from tengqm

Assignees

@tengqm tengqm

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@xrstf @tengqm @k8s-ci-robot @Arhell