Enable lychee link checking and fix outdated documentation links#1131
Open
vdstrizhkova wants to merge 1 commit into
Open
Enable lychee link checking and fix outdated documentation links#1131vdstrizhkova wants to merge 1 commit into
vdstrizhkova wants to merge 1 commit into
Conversation
vdstrizhkova
requested review from
TessFerrandez,
nyouens and
shiranr
as code owners
There was a problem hiding this comment.
Pull request overview
This PR enables automated link checking (Lychee via MegaLinter) and updates documentation/configuration links across the playbook to resolve broken/outdated references.
Changes:
- Expanded
lychee.tomlexclusions to reduce CI flakiness from sites that block automation or time out. - Enabled
SPELL_LYCHEEin MegaLinter. - Updated numerous documentation links (Grafana/Loki, sustainability, code review recipes, contributor guidance, templates).
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
lychee.toml |
Adds additional exclusions for known-bad-to-crawl but valid-in-browser sites. |
docs/source-control/component-versioning.md |
Updates Angular commit conventions reference link. |
docs/observability/tools/loki.md |
Updates Grafana Loki “getting started” documentation link. |
docs/observability/observability-databricks.md |
Replaces deleted Spark monitoring repo link with Microsoft monitoring guidance. |
docs/non-functional-requirements/privacy/data-handling.md |
Updates Limited DPA link to a direct PDF. |
docs/developer-experience/client-app-inner-loop.md |
Updates JsonServer reference to the maintained project. |
docs/design/sustainability/sustainable-engineering-principles.md |
Updates sustainability principle links to Green Software Foundation learning resources. |
docs/design/sustainability/README.md |
Updates an eco-mode resource link in the sustainability checklist table. |
docs/design/diagram-types/sequence-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/README.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/deployment-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/component-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/class-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/code-reviews/recipes/markdown.md |
Updates plain-language guidance link. |
docs/code-reviews/recipes/java.md |
Updates Azure Java SDK checkstyle configuration reference link. |
docs/automated-testing/synthetic-monitoring-tests/README.md |
Updates New Relic synthetics link. |
docs/agile-development/advanced-topics/collaboration/pair-programming-tools.md |
Updates Live Share documentation links to learn.microsoft.com. |
CONTRIBUTING.md |
Updates plain-language guidance link. |
.projector/workItemTemplates/kubernetes-at-the-edge.yml |
Updates Calico Windows limitations link to Tigera docs. |
.projector/workItemTemplates/engineering-fundamentals.yml |
Updates working agreement link path. |
.mega-linter.yml |
Enables SPELL_LYCHEE linter. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| `semantic-release` relies on commit messages to assess how codebase changes impact consumers. By adhering to structured conventions for commit messages, `semantic-release` autonomously identifies the subsequent semantic version, compiles a changelog, and releases the software. | ||
|
|
||
| [Angular Commit Message](https://gist.github.com/brianclements/841ea7bffdb01346392c) Conventions serve as the default for `semantic-release`. However, the configuration options of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins, including presets, can be adjusted to modify the commit message format. | ||
| [Angular Commit Message](https://github.com/angular/angular/blob/main/CONTRIBUTING.md) Conventions serve as the default for `semantic-release`. However, the configuration options of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins, including presets, can be adjusted to modify the commit message format. |
Comment on lines
+37
to
40
| Of all the logs collected, this is perhaps the most important one. [Spark Monitoring library](https://learn.microsoft.com/en-us/azure/architecture/databricks-monitoring/) collects metrics about the driver, executors, JVM, HDFS, cache | ||
| shuffling, DAGs, and much more. This library provides helpful insights to fine-tune Spark jobs. It allows monitoring and tracing each layer within Spark workloads, including performance and resource | ||
| usage on the host and JVM, as well as Spark metrics and application-level logging. The library also includes ready-made Grafana dashboards that is a great starting point for building Azure Databricks | ||
| dashboard. |
| ## [Energy Proportionality](https://principles.green/principles/energy-proportionality/) | ||
|
|
||
|  | ||
| ## [Energy Proportionality](https://learn.greensoftware.foundation/energy-efficiency/) |
| - [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) - requires a generator from code to PlantUML syntax to generate diagrams | ||
| - [PlantUML Syntax](https://plantuml.com/sequence-diagram) | ||
| - [Drawing manually](https://towardsdatascience.com/drawing-a-uml-diagram-in-the-vs-code-53c2e67deffe) | ||
| - [Drawing manually](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) |
| - [PlantUML Syntax](https://plantuml.com/class-diagram) | ||
| - [C# to PlantUML](https://marketplace.visualstudio.com/items?itemName=pierre3.csharp-to-plantuml) | ||
| - [Drawing manually](https://towardsdatascience.com/drawing-a-uml-diagram-in-the-vs-code-53c2e67deffe) | ||
| - [Drawing manually](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) |
| - [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) - requires a generator from code to PlantUML syntax to generate diagrams | ||
| - [PlantUML Syntax](https://plantuml.com/component-diagram) | ||
| - [Drawing manually](https://towardsdatascience.com/drawing-a-uml-diagram-in-the-vs-code-53c2e67deffe) | ||
| - [Drawing manually](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) |
| - [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) - requires a generator from code to PlantUML syntax to generate diagrams | ||
| - [C# to PlantUML](https://marketplace.visualstudio.com/items?itemName=pierre3.csharp-to-plantuml) | ||
| - [Drawing manually](https://towardsdatascience.com/drawing-a-uml-diagram-in-the-vs-code-53c2e67deffe) | ||
| - [Drawing manually](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) |
| - [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) - requires a generator from code to PlantUML syntax to generate diagrams | ||
| - [PlantUML Syntax](https://plantuml.com/deployment-diagram) | ||
| - [Drawing manually](https://towardsdatascience.com/drawing-a-uml-diagram-in-the-vs-code-53c2e67deffe) | ||
| - [Drawing manually](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) |
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.
Summary
Enables the lychee link checker for the docs and fixes the broken/outdated links it surfaced across the repository.
Changes
lychee.tomlconfiguration so the link checker runs against the documentation set.docs/design/diagram-types/*(class, component, deployment, sequence diagrams)docs/design/sustainability/*docs/observability/*(Loki tools, Databricks)docs/code-reviews/recipes/*(Java, Markdown)docs/source-control/component-versioning.mddocs/non-functional-requirements/privacy/data-handling.mddocs/developer-experience/client-app-inner-loop.mddocs/automated-testing/synthetic-monitoring-tests/README.md.mega-linter.yml, the.projectorwork item templates, andCONTRIBUTING.md.Scope
Single commit, 21 files changed (+33 / -28). No application/runtime code is affected — documentation and CI/link-check configuration only.
Testing