docs: fix internal cross-page references by injecting .md

[hirenp]

Fixing external references by injecting .md so that links works correctly while reading the documentation.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: hirenp (103858a)

[netlify]

✅ Deploy Preview for kubernetes-sigs-nfd ready!

Name	Link
🔨 Latest commit	bfbc47f
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-nfd/deploys/63c629ec440fab0008e622eb
😎 Deploy Preview	https://deploy-preview-1030--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 settings.

[k8s-ci-robot]

Welcome @hirenp!

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]

Hi @hirenp. 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/test-infra repository.

[ArangoGutierrez]

Thanks for this PR! could you update the PR description with a small line detailing the change, so we keep a nice git history.

/ok-to-test

[marquiz]

Thanks @hirenp for the PR. I guess you're reading the .md docs directly so that the links don't work. If we do this could you also fix all other references in a similar way

Something like this should give a good starting point, doing most of the work but possibly doing some incorrect edits and missing some, too:

# Remove all .md references
find docs/ -name '*.md' | xargs sed s'!.md#!!' -i

# Inject .md to all internal references
find docs/ -name '*.md' | xargs sed s'!(\([a-z0-9/.-]*[a-z]\)#\([a-z0-9-]*\))!(\1.md#\2)!' -i

[hirenp]

Something like this should give a good starting point, doing most of the work but possibly doing some incorrect edits and missing some, too:
Thanks! That seemed to have done the trick. I tried spot checking a couple places and they look correct to me.

[marquiz]

Thanks for the updater @hirenp. I found some mistakes, possibly because of erroneous sed script that I provided if you used them.

Could you also squash the PR into one commit and adjust the commit message accordingly, e.g. "docs: fix internal cross-page references by injecting .md" or smth

[hirenp]

Thanks for the updater @hirenp. I found some mistakes, possibly because of erroneous sed script that I provided if you used them.

Could you also squash the PR into one commit and adjust the commit message accordingly, e.g. "docs: fix internal cross-page references by injecting .md" or smth

Apologies for missing those. I fixed as per your suggestions.

[marquiz]

Apologies for missing those. I fixed as per your suggestions.

Np, thanks for the update @hirenp. Looks good, now. Just one last nit: could you remove the inadvertent quotation mark (", a copy-paste mistake(?)) from the end of the commit message

/retitle docs: fix internal cross-page references by injecting .md

[hirenp]

Apologies for missing those. I fixed as per your suggestions.

Np, thanks for the update @hirenp. Looks good, now. Just one last nit: could you remove the inadvertent quotation mark (", a copy-paste mistake(?)) from the end of the commit message

🤦‍♂️

Fixed. Thanks.

[marquiz]

👍

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hirenp, 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

[fmuyassarov]

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: dd8cf32706de9c300668bc9336cea485c97f3be1