Skip to content

fix: resolve markdown lint issues in install-perfsonar-testpoint.md#46

Merged
ShawnMcKee merged 2 commits intodocs/enhance-persona-pagesfrom
copilot/sub-pr-45
Dec 8, 2025
Merged

fix: resolve markdown lint issues in install-perfsonar-testpoint.md#46
ShawnMcKee merged 2 commits intodocs/enhance-persona-pagesfrom
copilot/sub-pr-45

Conversation

Copy link
Contributor

Copilot AI commented Dec 8, 2025

Fix markdown lint issues in install-perfsonar-testpoint.md

Summary

Automated markdown formatting introduced malformed code fence closures in install-perfsonar-testpoint.md. Fixed incorrect fence syntax, added missing language specifiers, and corrected indentation for code blocks within list items.

Changes

  • Code fence closures: Replaced malformed ````textclosings with proper ``` ` syntax (20 instances)
  • Indentation: Fixed code blocks in list items to use 4-space indentation
  • Language specifiers: Added text language to bare ``` fences to satisfy MD040
  • Blank lines: Ensured proper spacing around fences and lists per MD031/MD032

Verification

All persona and perfsonar docs now pass markdownlint validation with the project's .markdownlint.json config.

Files changed

  • docs/personas/quick-deploy/install-perfsonar-testpoint.md (49 insertions, 49 deletions)

Notes

These issues were artifacts from automated formatting scripts that replaced closing fences with opening fence syntax. The automated work was otherwise effective at addressing bulk linting issues.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…point.md

Co-authored-by: ShawnMcKee <3066214+ShawnMcKee@users.noreply.github.com>
Copilot AI changed the title [WIP] Enhance persona pages with playbooks and quick reference fix: resolve markdown lint issues in install-perfsonar-testpoint.md Dec 8, 2025
Copilot AI requested a review from ShawnMcKee December 8, 2025 00:42
@ShawnMcKee
Copy link
Contributor

@copilot fix(docs): reduce markdownlint warnings — formatting and safe fixes


This PR updates docs to resolve markdownlint violations and introduces safe formatting scripts.

Summary of changes:

  • Add scripts/join_hyphenated_urls.py to rejoin hyphen-split URLs
  • Improve scripts/format_markdown.py to normalize headings, list markers, fence languages, and paragraph wrapping
  • Apply markdownlint suggested insertText changes via scripts/apply_markdownlint_fixes.py
  • Convert inline HTML to Markdown where safe (images), and use angle brackets for bare URLs
  • Adjust heading levels and fix fence languages to address MD001/MD040/MD034
  • Reflow some long lines to address MD013 while avoiding changes to code examples

Files updated (representative):

  • docs/perfsonar/faq.md — fix hyphenated URLs, fence indentation & languages, heading levels
  • docs/perfsonar/installation.md — fix long lines, heading levels
  • docs/perfsonar/psetf.md — convert HTML images, reflow long paragraph
  • docs/perfsonar/install-testpoint.md — wrap config command URLs
  • docs/perfsonar/deployment-models.md — anchor and link fixes
  • docs/personas/quick-deploy/install-perfsonar-testpoint.md — multiple code fence fixes

Validation:

  • Re-ran markdownlint and confirmed no remaining violations across docs/**/*.md locally.

Notes:

  • These edits are intended to be non-semantic; however, please manually validate the major user flows (e.g., install/testpoint) where some lines were reflowed.
  • If any specific lines must remain unchanged (code samples, very long URLs), we can add specific linter disables (MD013/MD034) in a follow-up.

Request:

  • Please run the GitHub CI to validate the mkdocs build and check for any styling or rendering issues.

(Related branch: pr-46)

@ShawnMcKee
Copy link
Contributor

@copilot fix(docs): reduce markdownlint warnings across docs; tooling + safe formatting


Summary

This PR improves documentation consistency and reduces markdownlint CI failures across the docs/ tree by adding safe formatting tools and applying a conservative set of automated and manual fixes.

What I changed (high level)

  • Tools added:
    • scripts/join_hyphenated_urls.py — rejoin hyphenated URLs split over lines
    • scripts/apply_markdownlint_fixes.py — apply insertText fixes suggested by markdownlint --json
    • scripts/format_markdown.py — text wrapper and normalizer (blank lines, headings, fence languages, list spacing)
    • Other helper scripts added/updated to normalize fences and list markers
  • Doc changes (representative):
    • docs/perfsonar/faq.md — fixed hyphen split URL, normalized fences & fence languages, heading adjustments
    • docs/perfsonar/installation.md — resolved MD013 long line issues via reflow; adjusted headings sharing MD001 fixes
    • docs/perfsonar/psetf.md — converted inline HTML <img> to Markdown images; reflowed long paragraphs to reduce MD013
    • docs/perfsonar/deployment-models.md — added explicit anchor for the multiple NIC section and fixed the link break
    • docs/perfsonar/install-testpoint.md — wrapped remote config URL in angle brackets in the code block to fix MD034
    • docs/personas/quick-deploy/install-perfsonar-testpoint.md — corrected code fence closings and added language specifier to some code blocks
    • docs/perfsonar-in-osg.md, docs/perfsonar/perfSONAR-and-rp_filter-EL9.md — adjusted heading levels to satisfy MD001
  • Validation: re-ran markdownlint across all docs/**/*.md after changes; local checks showed no errors. Committed multiple fixes and reorganized headings and shorted long lines where safe.

Notes & Review Guidance

  • Changes are intended to be non-semantic where possible — mostly formatting, heading, link, and code fence improvements.
  • Pay special attention to docs/personas/quick-deploy/install-perfsonar-testpoint.md and docs/perfsonar/installation.md as they have many code examples and structural content that could be sensitive to line-wrap/indentation changes.
  • While markdownlint now passes locally, I recommend running the project CI (MKDocs build) to ensure HTML generation and any template-specific content remain unchanged.

Request

  • Please run CI on this branch.
  • If there are concerns about semantic changes in any command examples (e.g., wrapping or adding <...> angle brackets), let me know and I will revert or add explicit <!-- markdownlint-disable --> where needed.

(Branch: pr-46)

@ShawnMcKee ShawnMcKee merged commit 5875881 into docs/enhance-persona-pages Dec 8, 2025
6 of 8 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