Skip to content

Commit

Permalink
fix broken links (#998)
Browse files Browse the repository at this point in the history
* fix broken links

* fix broken links

---------

Co-authored-by: Tess Ferrandez <[email protected]>
  • Loading branch information
TessFerrandez and Tess Ferrandez authored Oct 18, 2023
1 parent 740e933 commit 4cbdd7e
Show file tree
Hide file tree
Showing 6 changed files with 4 additions and 22 deletions.
1 change: 0 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,6 @@
"profefe",
"promtail",
"Promtail",
"proselint",
"Pryce's",
"pscore",
"pseudocode",
Expand Down
1 change: 0 additions & 1 deletion docs/automated-testing/fault-injection-testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ Fault injection methods are a way to increase coverage and validate software rob
* **Error** - That part of the system state that may cause a subsequent failure.
* **Failure** - An event that occurs when the delivered service deviates from correct state.
* **Fault-Error-Failure cycle** - A key mechanism in [dependability](https://en.wikipedia.org/wiki/Dependability): A fault may cause an error. An error may cause further errors within the system boundary; therefore each new error acts as a fault. When error states are observed at the system boundary, they are termed failures.
(Modeled by [Laprie/Avizienis](https://www.nasa.gov/pdf/636745main_day_3-algirdas_avizienis.pdf))

#### Fault Injection Testing Basics

Expand Down
17 changes: 0 additions & 17 deletions docs/code-reviews/recipes/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,6 @@ markdownlint **/*.md --ignore node_modules --fix

A comprehensive list of markdownlint rules is available [here](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md).

### proselint

[`proselint`](http://proselint.com/) is a command line utility that lints the text contents of the document. It checks for jargon, spelling errors, redundancy, corporate speak and other language related issues.

It's available both as a [python package](https://github.com/amperser/proselint/#checks) and a [node package](https://www.npmjs.com/package/proselint).

```bash
pip install proselint
npm install -g proselint
```

Run proselint

```bash
proselint document.md
```

### write-good

[`write-good`](https://github.com/btford/write-good) is a linter for English text that helps writing better documentation.
Expand Down
1 change: 0 additions & 1 deletion docs/documentation/tools/automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ If you want to automate some checks on your Markdown documents, there are severa
- Code Analysis / Linting
- [markdownlint](../../code-reviews/recipes/markdown.md#markdownlint) to verify Markdown syntax and enforce rules that make the text more readable.
- [markdown-link-check](https://github.com/tcort/markdown-link-check) to extract links from markdown texts and check whether each link is alive (200 OK) or dead.
- [proselint](../../code-reviews/recipes/markdown.md#proselint) to check for jargon, spelling errors, redundancy, corporate speak and other language related issues.
- [write-good](../../code-reviews/recipes/markdown.md#write-good) to check English prose.
- [Docker image for node-markdown-spellcheck](https://github.com/tmaier/docker-markdown-spellcheck), a lightweight docker image to spellcheck markdown files.
- [static code analysis](../../continuous-integration/dev-sec-ops/static-code-analysis/static_code_analysis.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/observability/profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Unfortunately, each profiler tool typically uses its own format for storing prof
- (Java and Go) [Flame](https://github.com/VerizonMedia/kubectl-flame) - profiling containers in Kubernetes
- (Java, Python, Go) [Datadog Continuous profiler](https://www.datadoghq.com/product/code-profiling/)
- (Go) [profefe](https://github.com/profefe/profefe), which builds `pprof` to provide continuous profiling
- (Java) [Eclipse Memory Analyzer](https://www.eclipse.org/mat/)
- (Java) [Eclipse Memory Analyzer](https://eclipse.dev/mat/)
4 changes: 3 additions & 1 deletion linkcheck.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@
"https://blog.insightdatascience.com",
"https://www.w3.org/",
"https://mtirion.medium.com/",
"https://chrieke.medium.com/"
"https://chrieke.medium.com/",
"https://eclipse.dev/mat/",
"https://cloud.google.com/blog/products/gcp/cre-life-lessons-what-is-a-dark-launch-and-what-does-it-do-for-me"
],
"only_errors": true
}

0 comments on commit 4cbdd7e

Please sign in to comment.