Skip to content

chore(docs): update refs & normalize#50

Merged
ShawnMcKee merged 8 commits intomasterfrom
chore/docs-update-refs-norm
Dec 9, 2025
Merged

chore(docs): update refs & normalize#50
ShawnMcKee merged 8 commits intomasterfrom
chore/docs-update-refs-norm

Conversation

@ShawnMcKee
Copy link
Contributor

@ShawnMcKee ShawnMcKee commented Dec 9, 2025

chore(docs): repo-wide docs normalization, reference updates, and cleanup

Summary

This PR consolidates a number of conservative documentation fixes that were required to prevent mkdocs build failures and to reduce markdownlint noise. The changes are non-functional and were made to improve site stability, linter compliance (MD031/MD040/MD012/MD034/MD033 and related rules), and to avoid tracked temp artifacts.

What I changed

  • Fixed malformed/stray fenced code blocks and mis-indented lists causing mkdocs rendering/parsing errors (notably fixing the install-perfsonar-testpoint.md crash). This includes closing fences and normalizing fence indentation.
  • Added explicit fenced code languages (conservative heuristic; text added where ambiguous) to address MD040.
  • Applied markdownlint provided fixInfo items (insertions for MD031, deletions for MD012, and replacements for MD034) where safe to do so via scripts/apply_markdownlint_fixes.py and supporting scripts.
  • Removed tracked temporary and backup files (tmp/ and *.bak) and added .gitignore entries to avoid re-introducing them.
  • Updated links pointing to the deprecated install-testpoint.md page to use the installation.md legacy doc where appropriate (docs/personas/quick-deploy/landing.md, docs/perfsonar/CONTAINER_RESTART_ISSUE.md, etc.). Marked them as legacy where helpful.
  • Introduced a small GitHub Actions workflow which fails on PRs that contain tracked tmp/ or .bak files: .github/workflows/ban-temp-files.yml.
  • Small cleanups in perfSONAR pages (image tag fixes, minor inline HTML to markdown conversions) and reflowing long lines (MD013) where safe.

Files of interest

  • docs/personas/quick-deploy/install-perfsonar-testpoint.md — main fix for mkdocs crash due to broken fences and stray fence markers
  • docs/personas/quick-deploy/landing.md — replaced references to deprecated install-testpoint.md with installation.md
  • docs/perfsonar/installation.md — minor image link & admonition fixes
  • scripts/assign_fence_language.py, scripts/normalize_fence_indent.py, scripts/apply_markdownlint_fixes.py — new or extended scripts used to automate safe markdownlint driven edits
  • .github/workflows/ban-temp-files.yml — workflow added to prevent adding tmp back into the repo

Testing performed

  • Ran markdownlint repo-wide and applied JSON fixInfo items; after automation runs the majority of MD031/MD040/MD012 issues are resolved.
  • Created a Python venv, installed mkdocs and built the site locally (mkdocs build --clean) — the site builds successfully (non-fatal warnings remain relating to missing images and some anchor references).
  • Confirmed no freestanding tracked tmp/ or *.bak files remain; added .gitignore for these.

Remaining / follow-ups (manual review needed)

  • Several images referenced by pages are missing — these produce mkdocs warnings (e.g., perfsonar/installation.md links to ../../img/Screen_shot_2013-02-19_at_15.26.52.png). These warnings require manual decisions or adding the images.
  • Some ambiguous fenced code blocks were conservatively labeled text by heuristics — human review for language correctness is recommended.
  • MD013 (line length) and MD034 (bare URLs) issues may need targeted manual cleanups or small reflows.
  • Add scripts/README.md for documentation and potential unit tests for the automation scripts.

How to test locally

git fetch origin
git checkout chore/docs-update-refs-norm
python3 -m venv .venv
. .venv/bin/activate
pip install -U pip
pip install mkdocs mkdocs-material
mkdocs build --clean
markdownlint -f '**/*.md' --json | jq

Suggested reviewers and merge strategy

  • Suggested reviewers: perfSONAR docs maintainers and persona owners — for quick-deploy and perfsonar maintainers.
  • Merge strategy: Squash and merge is recommended for consolidation where many automated changes are applied. If you prefer preserving history, Merge is acceptable; Rebase is not required.

Notes and reasoning

  • These edits are intentionally conservative and non-semantic: edits to code blocks do not change command examples. Where uncertain, the text fenced-language was used. The goal is to make the site stable and the linter actionable for future smaller edits.

If you want me to further refine this PR (split to smaller PRs, enforce branch protection, or revert master-level commits into a clean PR branch), tell me the desired next step and I'll take care of it.

@ShawnMcKee ShawnMcKee merged commit 5977842 into master Dec 9, 2025
7 of 9 checks passed
@ShawnMcKee ShawnMcKee deleted the chore/docs-update-refs-norm branch December 9, 2025 14:31
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.

1 participant