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

Standardising relative pathnames: Security Best Practices + maybe elsewhere #1359

Open
wants to merge 1 commit into
base: staging
Choose a base branch
from

Conversation

rphair
Copy link
Collaborator

@rphair rphair commented Nov 21, 2024

Fixes problem reported here on Discord.

TL;DR: Some link syntaxes seem browser dependent & this is an attempt to standardise on a known working syntax for some material I wrote before some standards about inter-document linking were more rigorously applied.

For the link to Installing the node from source here, on the live site I've seen it open correctly with the URL into a new window but fail when simply clicking on the link.

  • To me this suggests something on the front end is interpreting the links (and likely not correct for me & my JS blocker) and sometimes getting it wrong when the Docusaurus source begins with .. or a relative pathname that doesn't begin with docs (although /docs seems to work just as well).

I've standardised the Security Best Practices pages which I wrote long ago & which had a hodgepodge of syntaxes, including the Air Gap link to the "Install from source" page that was reported broken above. I've concluded linking to docs/.../<filename>.md is canonical because output from this comment generally shows that syntax:

grep '](' `find docs -type f -name \*.md` | grep -v http | grep -v static.img | grep -v '(#' | grep -v cardano-improvement-proposals | grep '(.*)'

after repeated, recent edits by @CarlosLopezDeLara @gufmar on these files which have the most intra-Portal links: and so they are especially welcome to check the syntax changes here. (There are some other edits to bring the content up to date.)

@rphair rphair added the documentation Improvements or additions to documentation label Nov 21, 2024
@rphair rphair changed the title Security Best Practices: standardising relative pathnames Standardising relative pathnames: Security Best Practices (maybe elsewhere) Nov 22, 2024
@rphair rphair changed the title Standardising relative pathnames: Security Best Practices (maybe elsewhere) Standardising relative pathnames: Security Best Practices + maybe elsewhere Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant