Skip to content

Commit 2857cee

Browse files
authored
fix cspell and links checks (#912)
* fix cspell and links checks * Change list to enable linters instead of disable * fix megalinter version * Fix cspell * Fix cspell and links * revert link change * [MegaLinter] Apply linters fixes * revert fix * fix cspell Co-authored-by: shiranr <[email protected]>
1 parent bd90004 commit 2857cee

File tree

82 files changed

+8235
-247
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+8235
-247
lines changed

.cspell.json

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,12 @@
2525
"Aridhia",
2626
"Asana",
2727
"Autopep",
28+
"authpassword",
2829
"Autowire",
30+
"appconfig",
2931
"Azul",
32+
"azurem",
33+
"azurerm",
3034
"BYOK",
3135
"Bekso",
3236
"Bytedance",
@@ -38,12 +42,14 @@
3842
"CUDA",
3943
"CUITs",
4044
"Checkstyle",
45+
"CICD",
4146
"Cloudsploit",
4247
"Cobertura",
4348
"Conda",
4449
"Craftspersonship",
4550
"DARPA",
4651
"DAST",
52+
"datascience",
4753
"DBFS",
4854
"Databricks",
4955
"Dataverse",
@@ -58,7 +64,6 @@
5864
"FHEW",
5965
"FHIR",
6066
"FIPS",
61-
"Failureas",
6267
"Fairlearn",
6368
"Falco",
6469
"Federica",
@@ -91,6 +96,9 @@
9196
"Kubes",
9297
"Kustomization",
9398
"Kustomize",
99+
"keyvault",
100+
"Keyvault",
101+
"kvsecret",
94102
"Kyverno",
95103
"LINQ",
96104
"LLDB",
@@ -321,6 +329,7 @@
321329
"noninteractive",
322330
"nonoptimal",
323331
"nswag",
332+
"NPMJS",
324333
"omnisharp",
325334
"opensource",
326335
"opentelemetry",
@@ -373,6 +382,7 @@
373382
"securability",
374383
"serializability",
375384
"setvariable",
385+
"servicename",
376386
"shellcheck",
377387
"shfmt",
378388
"shunit",
@@ -417,18 +427,25 @@
417427
"webservice",
418428
"websockets",
419429
"westus",
430+
"westeurope",
420431
"winget",
421432
"workstream",
422433
"worspace",
423434
"yapf",
424435
"zstd",
425436
"Apdex",
426437
"Aur\u00e9lien",
427-
"Avi",
428-
"zienis",
438+
"Avizienis",
429439
"Customizabile",
440+
"CHECKOV",
430441
"Dodd's",
431-
"G\u00e9ron's"
442+
"Dodd’s",
443+
"G\u00e9ron's",
444+
"bugbug",
445+
"Bitnami",
446+
"Kubeseal",
447+
"KSOPS",
448+
"OTLP"
432449
],
433450
"version": "0.2"
434451
}

.mega-linter.yml

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,16 @@
33

44
APPLY_FIXES: all # all, none, or list of linter keys
55
# ENABLE: # If you use ENABLE variable, all other languages/formats/tooling-formats will be disabled by default
6-
# ENABLE_LINTERS: # If you use ENABLE_LINTERS variable, all other linters will be disabled by default
7-
DISABLE:
8-
- COPYPASTE # Comment to enable checks of excessive copy-pastes
9-
- HTML
10-
- DOCKERFILE
11-
- JSON
12-
DISABLE_LINTERS:
13-
- REPOSITORY_CHECKOV
14-
- REPOSITORY_GITLEAKS
15-
- SPELL_MISSPELL
16-
- YAML_V8R
6+
ENABLE_LINTERS:
7+
- ACTION_ACTIONLINT
8+
- MARKDOWN_MARKDOWNLINT
9+
- MARKDOWN_MARKDOWN_LINK_CHECK
10+
- MARKDOWN_MARKDOWN_TABLE_FORMATTER
11+
- REPOSITORY_SECRETLINT
12+
- SPELL_CSPELL
13+
- YAML_PRETTIER
14+
- YAML_YAMLLINT
15+
1716
SPELL_CSPELL_DISABLE_ERRORS: true
1817
SHOW_ELAPSED_TIME: true
1918
FILEIO_REPORTER: false

.projector/workItemTemplates/kubernetes-at-the-edge.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ items:
2121
description: Understand what workloads will be running on the cluster and the compute requirements including any requirements for mixed clusters (OS, cpu, mem, etc.)
2222
- name: Evaluate compute options
2323
type: task
24-
description: Reference this [trade-off doc](https://docs.microsoft.com/azure/architecture/operator-guides/aks/choose-kubernetes-edge-compute-option) to help evaluate trade-offs between bare-metal kubernetes, kubernetes on Azure Stack Edge, and AKS on Azure Stack HCI.
24+
description: Reference this [trade-off doc](https://learn.microsoft.com/azure/architecture/operator-guides/aks/choose-kubernetes-edge-compute-option) to help evaluate trade-offs between bare-metal kubernetes, kubernetes on Azure Stack Edge, and AKS on Azure Stack HCI.
2525
- name: If applicable, evaluate virtualization options
2626
type: task
2727
description: In the case of bare-metal, you will likely leverage virtualization of host systems. Look into what options are available for the respective host and evaluate against requirements
@@ -98,7 +98,7 @@ items:
9898
children:
9999
- name: Identify tooling to be used to spin up Kubernetes
100100
type: task
101-
description: For baremetal clusters, reference this [decision-tree](https://docs.microsoft.com/azure/architecture/operator-guides/aks/choose-bare-metal-kubernetes) to determine which tooling shall be used
101+
description: For baremetal clusters, reference this [decision-tree](https://learn.microsoft.com/azure/architecture/operator-guides/aks/choose-bare-metal-kubernetes) to determine which tooling shall be used
102102
- name: As a cluster operator, I want to leverage existing tools (AzDO, Ansible or cluster api) to configure my clusters so that configuration may be repeatable and scalable. Note, in cases where cluster setup requires a lot of manual coordination, it's important to determine how to automate and manage configuration such that clusters can be configured at scale
103103
type: story
104104
acceptanceCriteria:
@@ -115,7 +115,7 @@ items:
115115
type: story
116116
acceptanceCriteria:
117117
- Tests implemented in pipeline to ensure health of clusters post updates
118-
- name: As a cluster operator, I want to use a tool like azure arc for k8s (https://docs.microsoft.com/en-us/azure/azure-arc/kubernetes/) so that I can manage multiple clusters from a single pane of glass
118+
- name: As a cluster operator, I want to use a tool like azure arc for k8s (https://learn.microsoft.com/en-us/azure/azure-arc/kubernetes/) so that I can manage multiple clusters from a single pane of glass
119119
type: story
120120
acceptanceCriteria:
121121
- Decision record documenting requirements of single pane view, alternative considerations, and chosen tooling

docs/SPRINT-STRUCTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The purpose of this document is to:
2020
- Add [README.md](resources/templates/README.md), [LICENSE](resources/templates/LICENSE), [CONTRIBUTING.md](resources/templates/CONTRIBUTING.md), .gitignore, etc
2121
- [ ] [Build a Product Backlog](agile-development/advanced-topics/backlog-management/README.md)
2222
- Set up a project in your chosen project management tool (ex. Azure DevOps)
23-
- [INVEST](<https://en.wikipedia.org/wiki/INVEST_(mnemonic)>) in good User Stories and Acceptance Criteria
23+
- [INVEST](https://en.wikipedia.org/wiki/INVEST_(mnemonic)) in good User Stories and Acceptance Criteria
2424
- [Non-Functional Requirements Guidance](design/design-patterns/non-functional-requirements-capture-guide.md)
2525

2626
### Day 1

docs/accessibility/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Accessibility is a critical component of any successful project and ensures the
44

55
## Getting Started
66

7-
If you are new to accessibility or are looking for an overview of accessibility fundamentals, Microsoft Learn offers a great training course that covers a broad range of topics from creating accessible content in Office to designing accessibility features in your own apps. You can learn more about the course or get started at [Microsoft Learn: Accessibility Fundamentals](https://docs.microsoft.com/en-us/learn/paths/accessibility-fundamentals/).
7+
If you are new to accessibility or are looking for an overview of accessibility fundamentals, Microsoft Learn offers a great training course that covers a broad range of topics from creating accessible content in Office to designing accessibility features in your own apps. You can learn more about the course or get started at [Microsoft Learn: Accessibility Fundamentals](https://learn.microsoft.com/en-us/learn/paths/accessibility-fundamentals/).
88

99
## Accessibility Insights
1010

docs/agile-development/advanced-topics/collaboration/add-pairing-field-azure-devops-cards.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# How to add a Pairing Custom Field in Azure DevOps User Stories
22

3-
This document outlines the benefits of adding a custom field of type _Identity_ in [Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/user-guide/what-is-azure-devops) user stories, prerequisites, and a step-by-step guide.
3+
This document outlines the benefits of adding a custom field of type _Identity_ in [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/user-guide/what-is-azure-devops) user stories, prerequisites, and a step-by-step guide.
44

55
## Benefits of adding a custom field
66

77
Having the names of both individuals [pairing on a story](README.md) visible on the Azure DevOps cards can be helpful during sprint ceremonies and lead to greater accountability by the pairing assignee. For example, it is easier to keep track of the individuals assigned stories as part of a pair during sprint planning by using the "pairing names" field. During stand-up it can also help the Process Lead filter stories assigned to the individual (both as an owner or as a pairing assignee) and show these on the board. Furthermore, the pairing field can provide an additional data point for reports and burndown rates.
88

99
## Prerequisites
1010

11-
Prior to customizing Azure DevOps, review [Configure and customize Azure Boards](https://docs.microsoft.com/en-us/azure/devops/boards/configure-customize).
11+
Prior to customizing Azure DevOps, review [Configure and customize Azure Boards](https://learn.microsoft.com/en-us/azure/devops/boards/configure-customize).
1212

13-
In order to add a custom field to user stories in Azure DevOps changes must be made as an **Organizational setting**. This document therefore assumes use of an existing Organization in Azure DevOps and that the user account used to make these changes is a member of the [Project Collection Administrators Group](https://docs.microsoft.com/en-us/azure/devops/organizations/security/set-project-collection-level-permissions).
13+
In order to add a custom field to user stories in Azure DevOps changes must be made as an **Organizational setting**. This document therefore assumes use of an existing Organization in Azure DevOps and that the user account used to make these changes is a member of the [Project Collection Administrators Group](https://learn.microsoft.com/en-us/azure/devops/organizations/security/set-project-collection-level-permissions).
1414

1515
### Change the organization settings
1616

docs/agile-development/advanced-topics/effective-organization/delivery-plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@ Step 4: Based on your capacity, you know have the options
4242

4343
You can also leverage one of these tools by creating your epics and features and add the weeks estimates.
4444

45-
The [Plans (Preview) feature on Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/project/navigation/preview-features?view=azure-devops) will help you make a plan. Delivery Plans provide a schedule of stories or features your team plan to deliver. Delivery Plans show the scheduled work items by a sprint (iteration path) of selected teams against a calendar view.
45+
The [Plans (Preview) feature on Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/project/navigation/preview-features?view=azure-devops) will help you make a plan. Delivery Plans provide a schedule of stories or features your team plan to deliver. Delivery Plans show the scheduled work items by a sprint (iteration path) of selected teams against a calendar view.
4646

4747
Confluence JIRA, Trello, Rally, Asana, Basecamp, and GitHub Issues are other similar tools in the market (some are free, others you pay a monthly fee, or you can install on-prem) that you can leverage.

docs/agile-development/advanced-topics/team-agreements/definition-of-ready.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ When the development team picks a user story from the top of the backlog, the us
66
77
## What it is
88

9-
*Definition of Ready* is the agreement made by the scrum team around how complete a user story should be in order to be selected as candidate for estimation in the sprint planning. These can be codified as a checklist in user stories using [GitHub Issue Templates](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository) or [Azure DevOps Work Item Templates](https://docs.microsoft.com/en-us/azure/devops/boards/backlogs/work-item-template?view=azure-devops&tabs=browser).
9+
*Definition of Ready* is the agreement made by the scrum team around how complete a user story should be in order to be selected as candidate for estimation in the sprint planning. These can be codified as a checklist in user stories using [GitHub Issue Templates](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository) or [Azure DevOps Work Item Templates](https://learn.microsoft.com/en-us/azure/devops/boards/backlogs/work-item-template?view=azure-devops&tabs=browser).
1010

1111
It can be understood as a checklist that helps the Product Owner to ensure that the user story they wrote contains all the necessary details for the scrum team to understand the work to be done.
1212

docs/agile-development/basics/Backlog Management/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section has links directing you to best practices for managing Product and
44

55
- [Product Backlog](https://scrumguides.org/scrum-guide.html#product-backlog 'Product Backlog')
66
- [Sprint Backlog](https://scrumguides.org/scrum-guide.html#sprint-backlog 'Sprint Backlog')
7-
- [Acceptance Criteria](https://docs.microsoft.com/en-us/azure/devops/boards/backlogs/best-practices-product-backlog?view=azure-devops#acceptance-criteria 'Acceptance Criteria')
7+
- [Acceptance Criteria](https://learn.microsoft.com/en-us/azure/devops/boards/backlogs/best-practices-product-backlog?view=azure-devops#acceptance-criteria 'Acceptance Criteria')
88
- [Definition of Done](https://scrumguides.org/scrum-guide.html#increment 'Definition of Done')
99
- [Definition of Ready](https://www.scrum.org/resources/blog/walking-through-definition-ready 'Definition of Ready')
1010
- [Estimation Basics in Agile](https://www.scrum.org/resources/blog/what-scrum-says-about-estimates 'Estimation Basics in Agile')

docs/agile-development/basics/Ceremonies/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This section has links directing you to best practices for conducting the Agile ceremonies. After reading through the best practices you should have a basic understanding of the key Agile ceremonies in terms of purpose, value and best practices around conducting and facilitating these ceremonies.
44

55
- [Planning](https://scrumguides.org/scrum-guide.html#sprint-planning 'Sprint Planning')
6-
- [Refinement](https://docs.microsoft.com/devops/plan/what-is-agile-development#diligent-backlog-refinement 'Refinement')
6+
- [Refinement](https://learn.microsoft.com/devops/plan/what-is-agile-development#diligent-backlog-refinement 'Refinement')
77
- [Retrospective](https://scrumguides.org/scrum-guide.html#sprint-retrospective 'Retrospective')
88
- [Sprint Review/Demo](https://scrumguides.org/scrum-guide.html#sprint-review 'Sprint Review')
99
- [Stand-Up/Daily Scrum](https://scrumguides.org/scrum-guide.html#daily-scrum 'Stand-up/Daily Scrum')

docs/agile-development/basics/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
If you are new to Agile development or if you are looking for a refresher, this section will provides links to information that provide best pracices for Backlog Management, Agile Ceremonies, Roles within Agile and Agile Sprints.
44

5-
- [What is Agile](https://docs.microsoft.com/en-us/devops/plan/what-is-agile 'What is Agile')
6-
- [What is Agile Development](https://docs.microsoft.com/en-us/devops/plan/what-is-agile-development 'What is Agile Development')
5+
- [What is Agile](https://learn.microsoft.com/en-us/devops/plan/what-is-agile 'What is Agile')
6+
- [What is Agile Development](https://learn.microsoft.com/en-us/devops/plan/what-is-agile-development 'What is Agile Development')
77
- [Backlog Management](./Backlog%20Management/)
88
- [Ceremonies](./Ceremonies/)
99
- [Roles](./Roles/)

docs/agile-development/basics/Sprints/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This section has links directing you to best practices in regards to what a sprint is within agile and the practices around the sprint. After reading through the best practices you should have a basic understanding of Sprint Planning and the Sprint Backlog, Sprint Execution and the Daily Standup, Sprint Review and Sprint Retrospective and the key output of the sprint which is called the Increment.
44

5-
- [Sprint Planning and the Sprint Backlog](https://docs.microsoft.com/en-us/devops/plan/what-is-scrum#sprint-planning-and-the-sprint-backlog 'Sprint Planning and Sprint Backlog')
6-
- [Sprint Execution and the Daily Standup](https://docs.microsoft.com/en-us/devops/plan/what-is-scrum#sprint-execution-and-daily-scrum 'Sprint Execution and the Daily Standup')
7-
- [Sprint Review and Sprint Retrospective](https://docs.microsoft.com/en-us/devops/plan/what-is-scrum#sprint-review-and-sprint-retrospective 'Sprint Review and Sprint Retrospective')
8-
- [Increment](https://docs.microsoft.com/en-us/devops/plan/what-is-scrum#increment 'Increment')
5+
- [Sprint Planning and the Sprint Backlog](https://learn.microsoft.com/en-us/devops/plan/what-is-scrum#sprint-planning-and-the-sprint-backlog 'Sprint Planning and Sprint Backlog')
6+
- [Sprint Execution and the Daily Standup](https://learn.microsoft.com/en-us/devops/plan/what-is-scrum#sprint-execution-and-daily-scrum 'Sprint Execution and the Daily Standup')
7+
- [Sprint Review and Sprint Retrospective](https://learn.microsoft.com/en-us/devops/plan/what-is-scrum#sprint-review-and-sprint-retrospective 'Sprint Review and Sprint Retrospective')
8+
- [Increment](https://learn.microsoft.com/en-us/devops/plan/what-is-scrum#increment 'Increment')

docs/automated-testing/e2e-testing/recipes/gauge-framework.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -186,11 +186,14 @@ This section gives specific instructions on setting up Gauge in a macOS environm
186186
if HomeBrew is working properly, you should see something similar to the following:
187187
188188
```bash
189-
==> Downloading https://homebrew.bintray.com/bottles/gauge-1.0.6.mojave.bottle.tar.gz
190-
==> Downloading from https://akamai.bintray.com/45/45b496b39ee682a95ca49b36a94e8041e03fca3644e80223c36539f495fee384?__gda__=exp=1568017021~hmac=f6ca3a9
189+
==> Fetching gauge
190+
==> Downloading https://ghcr.io/v2/homebrew/core/gauge/manifests/1.4.3
191191
######################################################################## 100.0%
192-
==> Pouring gauge-1.0.6.mojave.bottle.tar.gz
193-
🍺 /usr/local/Cellar/gauge/1.0.6: 3 files, 18.5MB
192+
==> Downloading https://ghcr.io/v2/homebrew/core/gauge/blobs/sha256:05117bb3c0b2efeafe41e817cd3ad86307c1d2ea7e0e835655c4b51ab2472893
193+
==> Downloading from https://pkg-containers.githubusercontent.com/ghcr1/blobs/sha256:05117bb3c0b2efeafe41e817cd3ad86307c1d2ea7e0e835655c4b51ab2472893?se=2022-12-13T12%3A35%3A00Z&sig=I78SuuwNgSMFoBTT
194+
######################################################################## 100.0%
195+
==> Pouring gauge--1.4.3.ventura.bottle.tar.gz
196+
/usr/local/Cellar/gauge/1.4.3: 6 files, 18.9MB
194197
```
195198
196199
### Step 2 : Installing Gauge extension for Visual Studio Code

0 commit comments

Comments
 (0)