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

Fix Hugo relref references to work in md #100

Merged
merged 29 commits into from
Feb 2, 2024

Conversation

liamfallon
Copy link
Member

@liamfallon liamfallon commented Feb 1, 2024

This PR fixes the "ref" and "relref" links in the documentation so that they work in Markdown and thus Github. This will mean the links will not work in the Hugo documentation.

We need to figure out a way to get the links working in both but they really should work in Github.

The links are now all absolute links in order to pass linkspector and to work in md.

The linkspector tool fails on any link with a '#' in it, that is a link to a tag in any document. The change to the .linkspector file is to remove the '#' character and any following text, thus allowing those links to pass linkspector.

@liamfallon
Copy link
Member Author

/retest

@liamfallon
Copy link
Member Author

/assign @CsatariGergely @tliron @efiacor

Copy link
Contributor

nephio-prow bot commented Feb 1, 2024

@liamfallon: GitHub didn't allow me to assign the following users: CsatariGergely.

Note that only nephio-project members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @CsatariGergely @tliron @efiacor

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.

@liamfallon liamfallon changed the title Hugo relref Fix Hugo relref references to work in md Feb 1, 2024
@radoslawc
Copy link
Contributor

/lgtm

@CsatariGergely
Copy link
Contributor

Wow, this is really cool, in this way the links are working in GitHub also. I was not aware that this is doable. I've checked locally and it compiles nicely.
/lgtm

Copy link
Contributor

nephio-prow bot commented Feb 1, 2024

@CsatariGergely: changing LGTM is restricted to collaborators

In response to this:

Wow, this is really cool, in this way the links are working in GitHub also. I was not aware that this is doable. I've checked locally and it compiles nicely.
/lgtm

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.

@efiacor
Copy link
Contributor

efiacor commented Feb 2, 2024

/approve
/lgtm

Copy link
Contributor

nephio-prow bot commented Feb 2, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: efiacor

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

@nephio-prow nephio-prow bot added the approved label Feb 2, 2024
@nephio-prow nephio-prow bot merged commit 994ff89 into nephio-project:main Feb 2, 2024
4 checks passed
@liamfallon liamfallon deleted the hugo-relref branch February 2, 2024 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants