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

docs: use hugo ref/relref shortcodes for md links #2881

Closed
Tracked by #3113
ludfjig opened this issue Aug 23, 2023 · 7 comments · Fixed by #3027
Closed
Tracked by #3113

docs: use hugo ref/relref shortcodes for md links #2881

ludfjig opened this issue Aug 23, 2023 · 7 comments · Fixed by #3027
Assignees
Labels
good first issue Good for new contributors help wanted Good for someone who has contributed before user experience 🌈💖 Make it easier for everyone to use Porter website Great for people with graphic design and html/css skills

Comments

@ludfjig
Copy link
Contributor

ludfjig commented Aug 23, 2023

What design is being proposed?
Use the hugo ref/relref shortcodes for linking between pages in our docs. This will enable us to automatically detect broken links at build time.

@schristoff schristoff added user experience 🌈💖 Make it easier for everyone to use Porter help wanted Good for someone who has contributed before good first issue Good for new contributors website Great for people with graphic design and html/css skills labels Aug 31, 2023
@schristoff schristoff moved this to 📋 Backlog in Porter Aug 31, 2023
@Aayush987
Copy link

Hi, i would like to work on it. Can you assign it to me ?

@ludfjig
Copy link
Contributor Author

ludfjig commented Sep 11, 2023

Hi, i would like to work on it. Can you assign it to me ?

done :)

@Aayush987
Copy link

@ludfjig hi, just for the confirmation , i have to use hugo rel and relref shortcodes for all the interlinking of the pages in the docs, right?

@ludfjig
Copy link
Contributor Author

ludfjig commented Sep 19, 2023

@Aayush987 I realize that this is a bunch of boring manual work, and I'm not even sure short codes are what we want. It's possible there are better ways to do this.

For example, I found this which might be much easier. Perhaps you could investigate if there are other ways to detect broken links with Hugo, and if you find that creating a github workflow would be best, you could try adding it to our repo to see if it works.

@Aayush987
Copy link

@Aayush987 I realize that this is a bunch of boring manual work, and I'm not even sure short codes are what we want. It's possible there are better ways to do this.

For example, I found this which might be much easier. Perhaps you could investigate if there are other ways to detect broken links with Hugo, and if you find that creating a github workflow would be best, you could try adding it to our repo to see if it works.

OK, I will look into it .

@Aayush987
Copy link

@Aayush987 I realize that this is a bunch of boring manual work, and I'm not even sure short codes are what we want. It's possible there are better ways to do this.

For example, I found this which might be much easier. Perhaps you could investigate if there are other ways to detect broken links with Hugo, and if you find that creating a github workflow would be best, you could try adding it to our repo to see if it works.

Hi, i also think this workflow is the best method . I will start creating this workflow.

@illume
Copy link
Contributor

illume commented Mar 21, 2024

I'm working on this...

@schristoff schristoff moved this to In Progress in v1.1.0 (June 2024) Apr 4, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in v1.1.0 (June 2024) May 26, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Porter May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for new contributors help wanted Good for someone who has contributed before user experience 🌈💖 Make it easier for everyone to use Porter website Great for people with graphic design and html/css skills
Projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants