fix all markdown lint errors in docs #4833
Merged
Conversation
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
Add a small section on MFA
Unit Test Results0 tests 0 ✅ 0s ⏱️ Results for commit f8ea0df. ♻️ This comment has been updated with latest results. |
JC-wk
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request fixes markdown lint errors across documentation files by addressing table formatting issues, improving link text descriptions, and correcting spacing inconsistencies. The changes were verified using make lint-docs which now shows all markdown and YAML files lint successfully.
Changes:
- Fixed markdown table formatting by ensuring proper alignment of table separator rows with column headers
- Improved link text from generic phrases like "here" to descriptive text that indicates the link destination
- Added missing blank lines before and after tables and headings to comply with markdown formatting standards
Reviewed changes
Copilot reviewed 21 out of 27 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| templates/workspace_services/guacamole/user_resources/README.md | Fixed table formatting alignment for image properties documentation |
| docs/using-tre/templates/index.md | Replaced generic "here" links with descriptive link text |
| docs/tre-workspace-authors/firewall-rules.md | Fixed table separator formatting for multiple tables throughout the document |
| docs/tre-templates/workspaces/base.md | Added missing table cell content for client_secret description |
| docs/tre-templates/workspace-services/ohdsi.md | Improved link text from "here" to descriptive text |
| docs/tre-templates/user-resources/guacamole-linux-vm.md | Improved link text from "here" to descriptive reference |
| docs/tre-templates/shared-services/nexus.md | Removed trailing whitespace from table cell |
| docs/tre-templates/shared-services/gitea.md | Removed trailing whitespace and fixed URL formatting |
| docs/tre-developers/end-to-end-tests.md | Improved link text to be more descriptive |
| docs/tre-developers/api-permissions-map.md | Added blank lines before tables and fixed table alignment |
| docs/tre-admins/setup-instructions/deployment-repo.md | Improved link text with descriptive reference |
| docs/tre-admins/setup-instructions/configuring-shared-services.md | Replaced generic "here" links with descriptive text |
| docs/tre-admins/identities/workspace.md | Fixed table formatting and added blank lines before tables |
| docs/tre-admins/identities/test-account.md | Fixed table formatting and added blank lines before tables |
| docs/tre-admins/identities/client.md | Fixed table formatting and added blank lines before tables |
| docs/tre-admins/identities/auth-manual.md | Fixed table formatting and added blank line before table |
| docs/tre-admins/identities/application_admin.md | Fixed table separator formatting |
| docs/tre-admins/identities/api.md | Fixed table formatting and added blank lines before tables |
| docs/tre-admins/auth.md | Improved link text and fixed table formatting |
| docs/azure-tre-overview/user-roles.md | Fixed table separator formatting and improved link text |
| docs/azure-tre-overview/tre-resources-breakdown.md | Fixed table separator formatting across multiple resource tables |
| docs/azure-tre-overview/networking.md | Fixed table separator formatting |
| docs/azure-tre-overview/cost-reporting.md | Fixed table formatting and spacing |
| docs/azure-tre-overview/case-studies.md | Improved link text from "Click here" to descriptive references |
| docs/azure-tre-overview/architecture.md | Removed trailing whitespace from table cell |
| docs/azure-tre-overview/airlock.md | Fixed table formatting and improved link text |
| README.md | Added alt text attribute to Azure TRE logo image |
templates/workspace_services/guacamole/user_resources/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
templates/workspace_services/guacamole/user_resources/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Member
|
/test-force-approve 4c0cf02 docs only |
|
🤖 pr-bot 🤖 ✅ Marking tests as complete (for commit 4c0cf02) (in response to this comment from @marrobi) |
added 2 commits
January 30, 2026 17:13
tamirkamara
approved these changes
Feb 2, 2026
Member
|
/test-force-approve docs |
|
🤖 pr-bot 🤖 ✅ Marking tests as complete (for commit f8ea0df) (in response to this comment from @marrobi) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What is being addressed
fixes all markdown lint errors in docs
How is this addressed
make lint-docsto check for errors and resolved all issues