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

Build A Link #43

Closed
zkamvar opened this issue Dec 15, 2020 · 1 comment · Fixed by #136
Closed

Build A Link #43

zkamvar opened this issue Dec 15, 2020 · 1 comment · Fixed by #136
Milestone
1. Alpha phase

Comments

@zkamvar
Copy link
Contributor

zkamvar commented Dec 15, 2020 •
edited
Loading

Reference: https://zkamvar.github.io/stunning-barnacle#links

Contributors should be able to link to different parts of The Carpentries' ecosystem easily. We also want to make sure that we enforce canonical URLs to avoid situations where we have some sites that go to site.url/page/, site.url/page, and site.url/page.html

The use cases for linking are:

  1. within episodes (e.g. link to challenge)
  2. within lessons (e.g. link to references)
  3. across lessons (e.g. link to bash novice)
  4. across carpentries (e.g. link to glosario)

Note that canonical URLs can also be enforced via JavaScript: https://www.jpap.org/blog/2017/04/canonical-url-redirects-for-static-sites/ (but won't work if JavaScript is not enabled)
@zkamvar zkamvar modified the milestones: Documentation, Cross-linking syntax Dec 16, 2020
@zkamvar
Copy link
Contributor Author

zkamvar commented Dec 16, 2020

Across lessons, we can run the checker package and identify broken links periodically.

@zkamvar zkamvar removed this from the Cross-linking syntax milestone Dec 17, 2020
@fmichonneau fmichonneau added this to the alpha phase milestone Jan 27, 2021
zkamvar added a commit to carpentries/pegboard that referenced this issue Jul 28, 2021
@zkamvar
update link validation to not be so bad
3caac87 
I have updated the assumption for links to be a model where people will
create links _relative to the source files of the repository_. This will
do a couple of things:

1. Allow links to be follow-able if they are pure markdown files in the
   repository so that people can follow links in the github previews
2. People don't have to guess what the link outcome will be and we can
   tool around them.

Note that this means we will have to update our lua filters in sandpaper
to treat the links, but I was planning on doing that anyways in
carpentries/sandpaper#43
zkamvar added a commit that referenced this issue Jul 29, 2021
@zkamvar
add lua filter for links to fix #43
b914a35
@zkamvar zkamvar mentioned this issue Jul 29, 2021
Merged
@zkamvar zkamvar mentioned this issue Apr 13, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1. Alpha phase
Development

Successfully merging a pull request may close this issue.

add lua filter for links carpentries/sandpaper
2 participants
@zkamvar @fmichonneau