Docs: Fix the link to feature gates documentation #1821

ChaoyiHuang · 2024-07-29T09:38:37Z

The link to feature gates documentation is pointing to the
feature-gates.md in master-commandline-reference.html, it should be updated to link html file.

linux-foundation-easycla · 2024-07-29T09:38:41Z

The committers listed above are authorized under a signed CLA.

✅ login: ChaoyiHuang / name: Joe Huang (efd2bac, a442749)

k8s-ci-robot · 2024-07-29T09:38:45Z

Welcome @ChaoyiHuang!

It looks like this is your first PR to kubernetes-sigs/node-feature-discovery 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/node-feature-discovery has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-07-29T09:38:46Z

Hi @ChaoyiHuang. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

netlify · 2024-07-29T09:38:59Z

✅ Deploy Preview for kubernetes-sigs-nfd ready!

Name	Link
🔨 Latest commit	`a442749`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-nfd/deploys/66ab57a5fe16070008cbb7eb
😎 Deploy Preview	https://deploy-preview-1821--kubernetes-sigs-nfd.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

marquiz

Thanks you @ChaoyiHuang for the contribution. Please sign the CLA so we can get this merged 😊

/ok-to-test

marquiz

Now that we're at it, could you fix the same thing in docs/reference/master-commandline-reference.md, too?

marquiz · 2024-07-29T10:19:40Z

docs/reference/master-commandline-reference.md

@@ -34,7 +34,7 @@ Print version and exit.

 The `-feature-gates` flag is used to enable or disable non GA features.
 The list of available feature gates can be found in the [feature gates
-documentation](../feature-gates.md).
+documentation](feature-gates.md).


Looking at the netlify preview it didn't work (perhaps some bug in some 3rd party component in our docs building pipeline) 🤔 Maybe the links should not be split accross multiple lines(?)

Suggested change

documentation](feature-gates.md).

[feature gates documentation](feature-gates.md).

Looking at the netlify preview it didn't work (perhaps some bug in some 3rd party component in our docs building pipeline) 🤔 Maybe the links should not be split accross multiple lines(?)

will check to see how to address it

I just found why it doesn't work in netlify preview.

In netlify preview, if you click the item in the navigation bar "10.Feature Gates", it's pointing to "https://deploy-preview-1821--kubernetes-sigs-nfd.netlify.app/reference/feature-gates", and it works there. There is no ".md" for the page URL.

But in the "master-commandline-reference" page, the link to Feature Gates including suffix ".md" in the URL, that means URL "https://deploy-preview-1821--kubernetes-sigs-nfd.netlify.app/reference/feature-gates.md" won't work.

The jekyll should convert the relative link (feature-gates.md) to (feature-gates.html), but it didn't.

Need to figure out how to address the issue.

It should change the .md -> .html automatically when building the site. Do what I suggested above^ and I think it fixes it

yes, it's the multi-line issue, and some bug in jekyll rendering.

Both .md link and html link work Now.

ChaoyiHuang · 2024-07-30T00:49:43Z

Thanks you @ChaoyiHuang for the contribution. Please sign the CLA so we can get this merged 😊

/ok-to-test

Yes, I am waiting for CLA approve from corporate CLA Manager.

The link to feature gates documentation is pointing to the upward folder in master-commandline-reference.md, it should be updated to linking file in the same folder. Signed-off-by: joehuang <[email protected]>

ChaoyiHuang · 2024-08-01T01:42:28Z

Closes #1823

marquiz · 2024-08-01T05:11:08Z

Thanks @ChaoyiHuang. The worker cmdline reference is also broken similarly, could you fix that, too?
#1821 (review)

ChaoyiHuang · 2024-08-01T07:28:33Z

Thanks @ChaoyiHuang. The worker cmdline reference is also broken similarly, could you fix that, too? #1821 (review)

Sure, I will check other links and fix if necessary

The link to feature gates documentation is pointing to the feature-gates.md in master-commandline-reference.html and worker-commandline-reference.html, it should be updated to linking html file. Signed-off-by: joehuang <[email protected]>

marquiz

Thank your @ChaoyiHuang for fixing the links

/lgtm

marquiz · 2024-07-30T13:11:46Z

docs/Gemfile

+# render realtive link by plugin
+# https://github.blog/news-insights/product-news/relative-links-for-github-pages/
+gem 'jekyll-relative-links'


Don't seem to help

Suggested change

# render realtive link by plugin

# https://github.blog/news-insights/product-news/relative-links-for-github-pages/

gem 'jekyll-relative-links'

k8s-ci-robot · 2024-08-01T13:51:08Z

LGTM label has been added.

Git tree hash: 643dd0ab1c6b3412736c5b111fd984838671cecb

k8s-ci-robot · 2024-08-01T13:51:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ChaoyiHuang, marquiz

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:

~~OWNERS~~ [marquiz]

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 requested review from marquiz and zvonkok July 29, 2024 09:38

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 29, 2024

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 29, 2024

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 29, 2024

marquiz approved these changes Jul 29, 2024

View reviewed changes

marquiz reviewed Jul 29, 2024

View reviewed changes

ChaoyiHuang mentioned this pull request Jul 30, 2024

Docs: Fixed feature-gates reference #1822

Merged

ChaoyiHuang force-pushed the fixlink branch 2 times, most recently from 2875461 to 3e75769 Compare July 30, 2024 03:08

ChaoyiHuang force-pushed the fixlink branch from 3e75769 to 8fd8511 Compare July 30, 2024 03:55

Fix the link to feature gates documentation

efd2bac

The link to feature gates documentation is pointing to the upward folder in master-commandline-reference.md, it should be updated to linking file in the same folder. Signed-off-by: joehuang <[email protected]>

ChaoyiHuang force-pushed the fixlink branch from 8fd8511 to fd70ffb Compare August 1, 2024 01:20

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 1, 2024

ChaoyiHuang changed the title ~~Fix the link to feature gates documentation~~ Docs: Fix the link to feature gates documentation Aug 1, 2024

ChaoyiHuang force-pushed the fixlink branch from fd70ffb to a442749 Compare August 1, 2024 09:38

marquiz approved these changes Aug 1, 2024

View reviewed changes

k8s-ci-robot assigned marquiz Aug 1, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 1, 2024

k8s-ci-robot merged commit b2f2888 into kubernetes-sigs:master Aug 1, 2024
8 checks passed

ChaoyiHuang mentioned this pull request Aug 2, 2024

Docs: the markdown file was not rendered to html file in master-commandline-reference.html #1823

Closed

This was referenced Dec 11, 2024

Docs: Fix the link to feature gates documentation #1973

Merged

Release v0.17 #1875

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Fix the link to feature gates documentation #1821

Docs: Fix the link to feature gates documentation #1821

ChaoyiHuang commented Jul 29, 2024 •

edited

Loading

linux-foundation-easycla bot commented Jul 29, 2024 •

edited

Loading

k8s-ci-robot commented Jul 29, 2024

k8s-ci-robot commented Jul 29, 2024

netlify bot commented Jul 29, 2024 •

edited

Loading

marquiz left a comment

marquiz left a comment

marquiz Jul 29, 2024

ChaoyiHuang Jul 30, 2024

ChaoyiHuang Jul 30, 2024 •

edited

Loading

marquiz Jul 30, 2024

ChaoyiHuang Aug 1, 2024

ChaoyiHuang commented Jul 30, 2024

ChaoyiHuang commented Aug 1, 2024

marquiz commented Aug 1, 2024

ChaoyiHuang commented Aug 1, 2024

marquiz left a comment

marquiz Jul 30, 2024

k8s-ci-robot commented Aug 1, 2024

k8s-ci-robot commented Aug 1, 2024

	documentation](feature-gates.md).
	[feature gates documentation](feature-gates.md).

	# render realtive link by plugin
	# https://github.blog/news-insights/product-news/relative-links-for-github-pages/
	gem 'jekyll-relative-links'

Docs: Fix the link to feature gates documentation #1821

Docs: Fix the link to feature gates documentation #1821

Conversation

ChaoyiHuang commented Jul 29, 2024 • edited Loading

linux-foundation-easycla bot commented Jul 29, 2024 • edited Loading

k8s-ci-robot commented Jul 29, 2024

k8s-ci-robot commented Jul 29, 2024

netlify bot commented Jul 29, 2024 • edited Loading

✅ Deploy Preview for kubernetes-sigs-nfd ready!

marquiz left a comment

Choose a reason for hiding this comment

marquiz left a comment

Choose a reason for hiding this comment

marquiz Jul 29, 2024

Choose a reason for hiding this comment

ChaoyiHuang Jul 30, 2024

Choose a reason for hiding this comment

ChaoyiHuang Jul 30, 2024 • edited Loading

Choose a reason for hiding this comment

marquiz Jul 30, 2024

Choose a reason for hiding this comment

ChaoyiHuang Aug 1, 2024

Choose a reason for hiding this comment

ChaoyiHuang commented Jul 30, 2024

ChaoyiHuang commented Aug 1, 2024

marquiz commented Aug 1, 2024

ChaoyiHuang commented Aug 1, 2024

marquiz left a comment

Choose a reason for hiding this comment

marquiz Jul 30, 2024

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 1, 2024

k8s-ci-robot commented Aug 1, 2024

ChaoyiHuang commented Jul 29, 2024 •

edited

Loading

linux-foundation-easycla bot commented Jul 29, 2024 •

edited

Loading

netlify bot commented Jul 29, 2024 •

edited

Loading

ChaoyiHuang Jul 30, 2024 •

edited

Loading