Merged
Conversation
added 8 commits
December 9, 2025 08:11
…llation guide on quick-deploy landing
…of deprecated install-testpoint.md
…instead of deprecated install-testpoint.md
…ocs-update-refs-norm
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
install-perfsonar-testpoint.mdcrash). This includes closing fences and normalizing fence indentation.textadded where ambiguous) to address MD040.scripts/apply_markdownlint_fixes.pyand supporting scripts..gitignoreentries to avoid re-introducing them.install-testpoint.mdpage to use theinstallation.mdlegacy doc where appropriate (docs/personas/quick-deploy/landing.md,docs/perfsonar/CONTAINER_RESTART_ISSUE.md, etc.). Marked them aslegacywhere helpful..github/workflows/ban-temp-files.yml.Files of interest
docs/personas/quick-deploy/install-perfsonar-testpoint.md— main fix for mkdocs crash due to broken fences and stray fence markersdocs/personas/quick-deploy/landing.md— replaced references to deprecatedinstall-testpoint.mdwithinstallation.mddocs/perfsonar/installation.md— minor image link & admonition fixesscripts/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 repoTesting performed
markdownlintrepo-wide and applied JSONfixInfoitems; after automation runs the majority of MD031/MD040/MD012 issues are resolved.mkdocs build --clean) — the site builds successfully (non-fatal warnings remain relating to missing images and some anchor references).tmp/or*.bakfiles remain; added .gitignore for these.Remaining / follow-ups (manual review needed)
perfsonar/installation.mdlinks to../../img/Screen_shot_2013-02-19_at_15.26.52.png). These warnings require manual decisions or adding the images.textby heuristics — human review for language correctness is recommended.scripts/README.mdfor documentation and potential unit tests for the automation scripts.How to test locally
Suggested reviewers and merge strategy
Squash and mergeis recommended for consolidation where many automated changes are applied. If you prefer preserving history,Mergeis acceptable;Rebaseis not required.Notes and reasoning
textfenced-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.