Page MenuHomeFreeBSD

articles/committers-guide: fix README link
ClosedPublic

Authored by fernape on Feb 25 2021, 7:00 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Mar 31, 7:03 AM
Unknown Object (File)
Mar 5 2024, 1:12 AM
Unknown Object (File)
Mar 4 2024, 8:22 AM
Unknown Object (File)
Jan 14 2024, 10:42 PM
Unknown Object (File)
Dec 29 2023, 1:27 AM
Unknown Object (File)
Dec 22 2023, 10:54 PM
Unknown Object (File)
Nov 18 2023, 5:50 PM
Unknown Object (File)
Nov 18 2023, 5:20 PM
Subscribers
None

Details

Summary

Fix addkeys.sh README link.

Current link in Committer's Guide for the README of the addkeys.sh script is
broken.

It can be seen here:
https://docs.freebsd.org/en/articles/committers-guide/#commit-steps

It points to http://svnweb.freebsd.org/doc/head/shared/pgpkeys/README which
returns 404. It should point to https://docs.freebsd.org/pgpkeys/README.

Test Plan
  • Apply patch
  • Run make from documentation root
  • Go to Committer's Guide and check the new link.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

fernape created this revision.

Sorry, this is not completely right. It should be somehow relative to the doc structure. I'm trying to figure it out.

Properly constructing the link.

Mimic what is done in the handbook.

Sorry, this is not completely right. It should be somehow relative to the doc structure. I'm trying to figure it out.

Hi there, any progress on this one?

  • Fix link properly

I thought I had updated this but clearely I did not!

The original link was poiting to svnweb and hence returned a 404.
Now, we can not use a relative link because:

  • In my first approach, I linked to the doc repo and not the generated documents
  • The README is not in the generated documents set (i.e: the public dir)

So link agains the file in the repo as it was originally and just fix the URL.

This revision is now accepted and ready to land.Apr 18 2021, 5:32 PM
This revision was automatically updated to reflect the committed changes.