Fix invalid links in the documentation #1256
Conversation
|
Waiting for review on this. cc: @MarcusSorealheis, @allada, @aaronmondal |
There was a problem hiding this comment.
Reviewable status: 0 of 2 LGTMs obtained, and 0 of 8 files reviewed, and 1 discussions need to be resolved
CONTRIBUTING.md line 90 at r1 (raw file):
NativeLink ships almost all of its tooling in a nix flake which is configured via a [`flake.nix`](https://github.com/tracemachina/nativelink/tree/master/flake.nix) file in the root of the repository. While it's
nit: master => main
aleksdmladenovic
force-pushed
the
fix-invalid-links
branch
from
395df95 to
a6f5b12
Compare
There was a problem hiding this comment.
Done. cc: @allada
Reviewable status: 0 of 2 LGTMs obtained, and 0 of 8 files reviewed, and pending CI: Analyze (javascript-typescript), Analyze (python), Bazel Dev / ubuntu-22.04, Cargo Dev / macos-13, Cargo Dev / ubuntu-22.04, Installation / macos-13, Installation / macos-14, Installation / ubuntu-22.04, Local / ubuntu-22.04, Publish image, Publish nativelink-worker-init, Publish nativelink-worker-lre-cc, Remote / large-ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (22.04), integration-tests (22.04), macos-13, pre-commit-checks, ubuntu-20.04 / stable, ubuntu-22.04, ubuntu-22.04 / stable, vale, windows-2022 / stable
There was a problem hiding this comment.
+@blakehatch, please confirm the changes do what we want in docs. I can see a potential problem if we ever want to make a "staging" area for docs, since it'll point to public docs always.
Reviewed 3 of 8 files at r1, 5 of 5 files at r2, all commit messages.
Reviewable status: 0 of 2 LGTMs obtained, and all files reviewed, and pending CI: Remote / large-ubuntu-22.04 (waiting on @aaronmondal and @blakehatch)
There was a problem hiding this comment.
Reviewable status: 1 of 2 LGTMs obtained, and all files reviewed, and pending CI: Remote / large-ubuntu-22.04
Relative links in markdown files produce 404 error when it's deployed on the documentation site. Reviewed all relative links in markdown files and fixed them all. This commit doesn't include any CIs to prevent from 404 errors permanently ( maybe that's what to do next from here ), but it's a hotfix for currently not available links in the documentation website which are actually hurting user experience.
aleksdmladenovic
force-pushed
the
fix-invalid-links
branch
from
a6f5b12 to
62cede9
Compare
|
Rebased. Hope you to check this. cc: @MarcusSorealheis, @allada, @aaronmondal |
There was a problem hiding this comment.
Reviewable status: 1 of 2 LGTMs obtained, and all files reviewed (waiting on @blakehatch)
There was a problem hiding this comment.
I appreciate the ethos behind this as a hot-fix for the 404 issues, I do think it could cause problems for a "staging" area on the docs but that's less important than the imminent UX issue.
Only nit is that this PR should not close Aaron's issue #1242 even though it partially addresses it because we still need to build out the docs checking system. Other than that 
Reviewed all commit messages.
Reviewable status:complete! 2 of 2 LGTMs obtained, and all files reviewed
Description
Relative links in markdown files produce 404 error when it's deployed on the documentation site. Reviewed all relative links in markdown files and fixed them all. This commit doesn't include any CIs to prevent from 404 errors permanently ( maybe that's what to do next from here ), but it's a hotfix for currently not available links in the documentation website which are actually hurting user experience.
Fixes #1242
( Not a perfect fix for the issue, just a hotfix to solve the user-interfacing problems only )
Type of change
Please delete options that aren't relevant.
How Has This Been Tested?
It's been tested by deploying the documentation website locally.
Checklist
bazel test //...passes locallygit amendsee some docsThis change is