Skip to content

Expert Contributing Guide - added a section on linking to other guides properly#3187

Merged
sspencerwire merged 1 commit intorocky-linux:mainfrom
metalllinux:cusp-2101-linking-guide
Mar 5, 2026
Merged

Expert Contributing Guide - added a section on linking to other guides properly#3187
sspencerwire merged 1 commit intorocky-linux:mainfrom
metalllinux:cusp-2101-linking-guide

Conversation

@metalllinux
Copy link
Contributor

@metalllinux metalllinux commented Mar 5, 2026

Thanks to Steven for discussing this one and I've added a section in my expert contributing guide, which tells users exactly how to link to other guides in the Rocky Linux Docs.

Author checklist (Completed by original Author)

  • Good fit for the Rocky Linux project? Title and Author Metatags inserted ?
  • If applicable, steps and instructions have been tested to work
  • Initial self-review to fix basic typos and grammar completed

Rocky Documentation checklist (Completed by Rocky team)

  • 1st Pass (Document is good fit for project and author checklist completed)
  • 2nd Pass (Technical Review - check for technical correctness)
  • 3rd Pass (Detailed Editorial Review and Peer Review)
  • Final approval (Final Review)

Add a new "Linking to other guides" section under Formatting guidelines
explaining to use relative file paths instead of full URLs for internal
links within the Rocky Linux documentation.

Assisted-by: Claude claude-sonnet-4-6
Co-Authored-By: Howard Van Der Wal <hvanderwal@ciq.com>
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

Test results for db1a84f:

Number of broken URLs: 14

URL,RESULT,FILENAME
 http://$(hostname):8080,failed,guides/repositories/pulp_fetch_upload.md
 http://your_ip,failed,guides/cms/mediawiki.md
 https://dl.rockylinux.org/pub/rocky/9.6/live/x86_64/,failed,guides/desktop/kde_installation.md
 https://wiki.rockylinux.org/team/release_engineering/debranding/,failed,guides/package_management/package_debranding.md
 https://ftp.gnu.org/gnu/tar/,failed,guides/backup/tar.md
 https://support.torproject.org/glossary/pluggable-transports/,failed,guides/proxies/tor_relay.md
 https://andyscott.me,failed,guides/contribute/README.md
 https://docs.rockylinux.org/guides/contribute/ai-contribution-policy.md,failed,guides/contribute/README.md
 https://allcontributors.org/docs/en/emoji-key,failed,guides/contribute/README.md
 https://git.launchpad.net/cloud-init,failed,guides/virtualization/cloud-init/07_contributing.md
 https://www.packer.io/docs/builders/vsphere/vsphere-iso,failed,guides/automation/templates-automation-packer-vsphere.md
 https://ftp.gnu.org/gnu/hello/hello-2.12.tar.gz,failed,labs/systems_administration_I/lab7-software_management.md
 https://repocompare.rockylinux.org,failed,release_notes/8_5.md
 https://mirrors.fedoraproject.org/metalink?repo=epel-8&arch=$basearch&infra=$infra&content=$contentdir,failed,books/admin_guide/13-softwares.md

@sspencerwire sspencerwire merged commit 4963f1c into rocky-linux:main Mar 5, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants