Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links and markdown #993

Merged
merged 10 commits into from
Sep 18, 2023
Merged

Fix broken links and markdown #993

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ca0d0c4
clean up privacy readme
Sep 12, 2023
7467e67
ignoring medium.com and towardsdatascience.com as they reject bots
Sep 12, 2023
8991c87
fixing ignores
Sep 12, 2023
bd56b72
ignoring github.com
Sep 12, 2023
c3c8912
cleaning up links
Sep 13, 2023
0e83d51
add linkcheck.json
Sep 13, 2023
075790a
remove the ignore patterns in the markdown link checker file as they …
Sep 13, 2023
3b09da4
add ignore links
Sep 13, 2023
477ad7c
remove fnocera and add shiran
Sep 13, 2023
833811d
ignore github
Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* @tessferrandez @fnocera @nyouens
* @tessferrandez @shiranr @nyouens

/docs/* @tessferrandez @shiranr @tompaana

56 changes: 15 additions & 41 deletions .markdown-link-check.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,17 @@
{
"ignorePatterns": [
{"pattern": "^./INSERT_URL_TO_ISSUE"},
{"pattern": "^./link-to-the-work-item"},
{"pattern": "^https://portal.azure.com"},
{"pattern": "^http://link-to-feature-or-story-work-item"},
{"pattern": "^http://link-to-task-work-item"},
{"pattern": "^http://link-to-story-work-item"},
{"pattern": "^http://link-to-work-item"},
{"pattern": "^https://tanzu.vmware.com/developer/guides/kubernetes/observability-prometheus-grafana-p1"},
{"pattern": "^https://www.w3.org/blog/2019/12/trace-context-enters-proposed-recommendation/"},
{"pattern": "^https://blog.cloudflare.com/cloudflare-outage/"},
{"pattern": "^https://thanos.io"},
{"pattern": "^https://gitlab.com/palisade/palisade-release"},
{"pattern": "(.*\\.)?.opentelemetry.io"},
{"pattern": "(.*\\.)?.pluralsight.com"},
{"pattern": "^https://www.github.com"},
{"pattern": "^https://marketplace.visualstudio.com"},
{"pattern": "^https://opensource.org/licenses/MIT"},
{"pattern": "^https://www.researchgate.net/publication/301839557_The_landscape_of_software_failure_cause_models"},
{"pattern": "^https://www.cmu.edu/iso/governance/guidelines/data-classification.html"},
{"pattern": "^https://machinelearningmastery.com/how-to-get-baseline-results-and-why-they-matter/"},
{"pattern": "^https://www.perfecto.io/"},
{"pattern": "^https://www.ranorex.com/free-trial/"},
{"pattern": "^https://argo-cd.readthedocs.io/"},
{"pattern": "^http://pytest.org/"},
{"pattern": "^http://code.visualstudio.com/"},
{"pattern": "^https://plantuml.com/"}
],
"httpHeaders": [
{
"urls": ["https://docs.github.com/",
"https://help.github.com/",
"https://github.com/",
"https://blog.cloudflare.com/"],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
"ignorePatterns": [],
"httpHeaders": [
{
"urls": [
"https://docs.github.com/",
"https://help.github.com/",
"https://github.com/",
"https://blog.cloudflare.com/"],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
}
}
}
],
"retryOn429": true,
"aliveStatusCodes": [200, 206, 302, 0]
}
],
"retryOn429": true,
"aliveStatusCodes": [200, 206, 302, 0]
}
2 changes: 1 addition & 1 deletion docs/code-reviews/recipes/markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ Save your guidelines together with your documentation, so they are easy to refer
- Avoid duplication of content, instead link to the `single source of truth`
- Link but don't summarize. Summarizing content on another page leads to the content living in two places
- Use meaningful anchor texts, e.g. instead of writing `Follow the instructions [here](../recipes/markdown.md)` write `Follow the [Markdown guidelines](../recipes/markdown.md)`
- Make sure links to Microsoft docs (like `https://learn.microsoft.com/something/somethingelse`) do not contain the language marker `/en-us/` or `/fr-fr/`, as this is automatically determined by the site itself.
- Make sure links to Microsoft docs do not contain the language marker `/en-us/` or `/fr-fr/`, as this is automatically determined by the site itself.

### Lists

Expand Down
22 changes: 11 additions & 11 deletions docs/continuous-delivery/recipes/terraform/save-output-to-variable-group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,22 +118,22 @@ In addition, you can notice we are also using [predefined variables](https://lea
AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)
```

| System variables | Description |
| -- | -- |
| [System.AccessToken](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#systemaccesstoken)| Special variable that carries the security token used by the running build. |
| [System.TeamFoundationCollectionUri](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#system-variables-devops-services) | The URI of the Azure DevOps organization. |
| [System.TeamProjectId](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#system-variables-devops-services) | The ID of the project that this build belongs to. |
| System variables | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| [System.AccessToken](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#systemaccesstoken) | Special variable that carries the security token used by the running build. |
| [System.TeamFoundationCollectionUri](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#system-variables-devops-services) | The URI of the Azure DevOps organization. |
| [System.TeamProjectId](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#system-variables-devops-services) | The ID of the project that this build belongs to. |

## Library security

Roles are defined for Library items, and membership of these roles governs the operations you can perform on those items.

| Role for library item | Description |
| -- | -- |
| Reader | Can view the item. |
| User | Can use the item when authoring build or release pipelines. For example, you must be a 'User' for a variable group to use it in a release pipeline. |
| Administrator | Can also manage membership of all other roles for the item. The user who created an item gets automatically added to the Administrator role for that item. By default, the following groups get added to the Administrator role of the library: Build Administrators, Release Administrators, and Project Administrators. |
| Creator | Can create new items in the library, but this role doesn't include Reader or User permissions. The Creator role can't manage permissions for other users. |
| Role for library item | Description |
|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Reader | Can view the item. |
| User | Can use the item when authoring build or release pipelines. For example, you must be a 'User' for a variable group to use it in a release pipeline. |
| Administrator | Can also manage membership of all other roles for the item. The user who created an item gets automatically added to the Administrator role for that item. By default, the following groups get added to the Administrator role of the library: Build Administrators, Release Administrators, and Project Administrators. |
| Creator | Can create new items in the library, but this role doesn't include Reader or User permissions. The Creator role can't manage permissions for other users. |

When using `System.AccessToken`, service account `<ProjectName> Build Service` identity will be used to access the Library.

Expand Down
6 changes: 3 additions & 3 deletions docs/continuous-integration/devcontainers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Here are below pros and cons for both approaches:
### Run CI pipelines in native environment

| Pros | Cons |
| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|-------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| Can use any pipeline tasks available | Need to keep two sets of tooling and their versions in sync |
| No container registry | Can take some time to start, based on tools/dependencies required |
| Agent will always be up to date with security patches | The dev container should always be built within each run of the CI pipeline, to verify the changes within the branch haven't broken anything |

### Run CI pipelines in the dev container without image caching

| Pros | Cons |
| -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| Utilities scripts will work out of the box | Need to rebuild the container for each run, given that there may be changes within the branch being built |
| Rules used (for linting or unit tests) will be the same on the CI | Not everything in the container is needed for the CI pipeline&#185; |
| No surprise for the developers, local outputs (of linting for instance) will be the same in the CI | Some pipeline tasks will not be available |
Expand All @@ -44,7 +44,7 @@ Here are below pros and cons for both approaches:
### Run CI pipelines in the dev container with image registry

| Pros | Cons |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| Utilities scripts will work out of the box | Need to rebuild the container for each run, given that there may be changes within the branch being built |
| No surprise for the developers, local outputs (of linting for instance) will be the same in the CI | Not everything in the container is needed for the CI pipeline&#185; |
| Rules used (for linting or unit tests) will be the same on the CI | Some pipeline tasks will not be available &#178; |
Expand Down
2 changes: 1 addition & 1 deletion docs/machine-learning/ml-feasibility-study.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,5 @@ The main outcome is a feasibility study report, with a recommendation on next st
* We may look at re-scoping the problem taking into account the findings of the feasibility study
* We assess the possibility to collect more data or improve data quality

- If there is enough evidence to support the hypothesis that this problem can be solved using ML
- If there is enough evidence to support the hypothesis that this problem can be solved using ML
* Provide recommendations and technical assets for moving to the operationalization phase
4 changes: 1 addition & 3 deletions docs/machine-learning/ml-project-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ Within this framework, the team follows these Agile ceremonies:
#### Examples of ML deliverables for each sprint

- Working code (e.g. models, pipelines, exploratory code)
- Documentation of new hypotheses, and the acceptance or rejection of previous hypotheses as part of a Hypothesis Driven Analysis (HDA). See more resources on HDA here:
1. [HDA](https://datasciencevademecum.com/2015/11/10/agile-data-science-iteration-0-the-hypothesis-driven-analysis) (from the Data Science Vademecum website).
2. [Hypothesis Driven Development](https://barryoreilly.com/explore/blog/how-to-implement-hypothesis-driven-development/) (from Barry Oreilly's website).
- Documentation of new hypotheses, and the acceptance or rejection of previous hypotheses as part of a Hypothesis Driven Analysis (HDA). For more information see [Hypothesis Driven Development on Barry Oreilly's website](https://barryoreilly.com/explore/blog/how-to-implement-hypothesis-driven-development/)
- Exploratory Data Analysis (EDA) results and learnings documented

## Notes on collaboration between ML team and software development team
Expand Down
Loading