Merge branch 'main' of https://github.com/maansi-1608/code-with-engin…

…eering-playbook into maansi/semantic-versionining-monorepo
microsoft · Oct 18, 2023 · bb6bf89 · bb6bf89
2 parents 82e703c + 4cbdd7e
commit bb6bf89
Show file tree

Hide file tree

Showing 7 changed files with 5 additions and 23 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -317,7 +317,6 @@
     "profefe",
     "promtail",
     "Promtail",
-    "proselint",
     "Pryce's",
     "pscore",
     "pseudocode",

diff --git a/docs/automated-testing/fault-injection-testing/README.md b/docs/automated-testing/fault-injection-testing/README.md
@@ -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
 

diff --git a/docs/code-reviews/recipes/markdown.md b/docs/code-reviews/recipes/markdown.md
@@ -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.

diff --git a/docs/documentation/tools/automation.md b/docs/documentation/tools/automation.md
@@ -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)

diff --git a/docs/observability/profiling.md b/docs/observability/profiling.md
@@ -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/)
diff --git a/linkcheck.json b/linkcheck.json
@@ -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
   }
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -1,6 +1,6 @@
 mkdocs==1.3.*
 mkdocs-material==8.2.*
-pymdown-extensions==9.4.*
+pymdown-extensions>=10.0
 markdown==3.3.*
 mdx_truly_sane_lists==1.2
 mkdocs-git-revision-date-localized-plugin==1.0.*