From 71946f58078a2a4cd9f766547dc74ad4157ea745 Mon Sep 17 00:00:00 2001 From: shiranrubin Date: Thu, 21 Jul 2022 18:21:27 +0300 Subject: [PATCH] Fix broken links --- docs/ENG-FUNDAMENTALS-CHECKLIST.md | 2 +- docs/SPRINT-STRUCTURE.md | 4 ++-- .../effective-organization/scrum-of-scrums.md | 2 +- .../team-agreements/definition-of-ready.md | 2 +- .../team-agreements/working-agreements.md | 16 ++++++++-------- docs/code-reviews/recipes/markdown.md | 2 +- .../design-reviews/recipes/engagement-process.md | 2 +- .../recipes/using-docfx-and-tools.md | 2 +- docs/machine-learning/ml-project-management.md | 2 +- docs/source-control/git-guidance/README.md | 4 ++-- 10 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/ENG-FUNDAMENTALS-CHECKLIST.md b/docs/ENG-FUNDAMENTALS-CHECKLIST.md index 6b6f7492e3..7733d30924 100644 --- a/docs/ENG-FUNDAMENTALS-CHECKLIST.md +++ b/docs/ENG-FUNDAMENTALS-CHECKLIST.md @@ -20,7 +20,7 @@ More details on [source control](source-control/README.md) - [ ] All items are tracked in AzDevOps (or similar). - [ ] The board is organized (swim lanes, feature tags, technology tags). -More details on [backlog management](agile-development/advanced-topics/backlog-management/readme.md) +More details on [backlog management](agile-development/advanced-topics/backlog-management/README.md) ## Testing diff --git a/docs/SPRINT-STRUCTURE.md b/docs/SPRINT-STRUCTURE.md index 7c9e8b5c88..af8603c59e 100644 --- a/docs/SPRINT-STRUCTURE.md +++ b/docs/SPRINT-STRUCTURE.md @@ -18,7 +18,7 @@ The purpose of this document is to: - [ ] [Set up the repository/repositories](source-control/README.md#creating-a-new-repository) - Decide on repository structure/s - Add [README.md](resources/templates/README.md), [LICENSE](resources/templates/LICENSE), [CONTRIBUTING.md](resources/templates/CONTRIBUTING.md), .gitignore, etc -- [ ] [Build a Product Backlog](agile-development/advanced-topics/backlog-management/readme.md) +- [ ] [Build a Product Backlog](agile-development/advanced-topics/backlog-management/README.md) - Set up a project in your chosen project management tool (ex. Azure DevOps) - [INVEST]() in good User Stories and Acceptance Criteria - [Non-Functional Requirements Guidance](design/design-patterns/non-functional-requirements-capture-guide.md) @@ -68,7 +68,7 @@ The purpose of this document is to: - [ ] [Conduct a Retrospective](agile-development/core-expectations/README.md) - Determine required participants, how to capture input (tools) and outcome - Set a timeline, and discuss facilitation, meeting structure etc. -- [ ] [Refine the Backlog](agile-development/advanced-topics/backlog-management/readme.md) +- [ ] [Refine the Backlog](agile-development/advanced-topics/backlog-management/README.md) - Determine required participants - Update the [Definition of Ready](agile-development/advanced-topics/team-agreements/definition-of-ready.md) - Update estimates, and the [Estimation](agile-development/core-expectations/README.md) document diff --git a/docs/agile-development/advanced-topics/effective-organization/scrum-of-scrums.md b/docs/agile-development/advanced-topics/effective-organization/scrum-of-scrums.md index eaf8b3db13..3bf17afa68 100644 --- a/docs/agile-development/advanced-topics/effective-organization/scrum-of-scrums.md +++ b/docs/agile-development/advanced-topics/effective-organization/scrum-of-scrums.md @@ -15,7 +15,7 @@ The scrum of scrums ceremony happens every day and can be seen as a regular [sta The outcome of the meeting will result in a list of impediments related to coordination of the whole project. Solutions could be: agreeing on interfaces between teams, discussing architecture changes, evolving responsibility boundaries, etc. -This list of impediments is usually managed in a separate [backlog](../backlog-management/readme.md) but does not have to. +This list of impediments is usually managed in a separate [backlog](../backlog-management/README.md) but does not have to. ## Participation diff --git a/docs/agile-development/advanced-topics/team-agreements/definition-of-ready.md b/docs/agile-development/advanced-topics/team-agreements/definition-of-ready.md index 78f1f0edf9..e0ef199beb 100644 --- a/docs/agile-development/advanced-topics/team-agreements/definition-of-ready.md +++ b/docs/agile-development/advanced-topics/team-agreements/definition-of-ready.md @@ -37,6 +37,6 @@ The ready checklist should contain items that apply broadly. Don't include items In the case that the highest priority work is not yet ready, it still may be possible to make forward progress. Here are some strategies that may help: -* [Backlog Refinement](../backlog-management/readme.md) sessions are a good time to validate that high priority user stories are verified to have a clear description, acceptance criteria and demonstrable business value. It is also a good time to breakdown large stories will likely not be completable in a single sprint. +* [Backlog Refinement](../backlog-management/README.md) sessions are a good time to validate that high priority user stories are verified to have a clear description, acceptance criteria and demonstrable business value. It is also a good time to breakdown large stories will likely not be completable in a single sprint. * Prioritization sessions are a good time to prioritize user stories that unblock other blocked high priority work. * Blocked user stories can often be broken down in a way that unblocks a portion of the original stories scope. This is a good way to make forward progress even when some work is blocked. diff --git a/docs/agile-development/advanced-topics/team-agreements/working-agreements.md b/docs/agile-development/advanced-topics/team-agreements/working-agreements.md index b67c4742bf..5e5ab681dc 100644 --- a/docs/agile-development/advanced-topics/team-agreements/working-agreements.md +++ b/docs/agile-development/advanced-topics/team-agreements/working-agreements.md @@ -37,14 +37,14 @@ their own, and adjust times, communication channels, branch naming policies etc. ## Scrum Rhythm -| Activity | When | Duration | Who | Accountable | Goal | -|-|-|-|-|-|-| -| [Project Standup](../../core-expectations/README.md) | Tue-Fri 9AM | 15 min | Everyone | Process Lead | What has been accomplished, next steps, blockers | -| Sprint Demo | Monday 9AM | 1 hour | Everyone | Dev Lead | Present work done and sign off on user story completion | -| [Sprint Retro](../../core-expectations/README.md) | Monday 10AM | 1 hour | Everyone | Process Lead | Dev Teams shares learnings and what can be improved | -| [Sprint Planning](../../core-expectations/README.md) | Monday 11AM | 1 hour | Everyone | PO | Size and plan user stories for the sprint | -| Task Creation | After Sprint Planning | - | Dev Team | Dev Lead | Create tasks to clarify and determine velocity | -| [Backlog refinement](../backlog-management/readme.md) | Wednesday 2PM | 1 hour | Dev Lead, PO | PO | Prepare for next sprint and ensure that stories are ready for next sprint. | +| Activity | When | Duration | Who | Accountable | Goal | +|-------------------------------------------------------|-----------------------|----------|--------------|--------------|----------------------------------------------------------------------------| +| [Project Standup](../../core-expectations/README.md) | Tue-Fri 9AM | 15 min | Everyone | Process Lead | What has been accomplished, next steps, blockers | +| Sprint Demo | Monday 9AM | 1 hour | Everyone | Dev Lead | Present work done and sign off on user story completion | +| [Sprint Retro](../../core-expectations/README.md) | Monday 10AM | 1 hour | Everyone | Process Lead | Dev Teams shares learnings and what can be improved | +| [Sprint Planning](../../core-expectations/README.md) | Monday 11AM | 1 hour | Everyone | PO | Size and plan user stories for the sprint | +| Task Creation | After Sprint Planning | - | Dev Team | Dev Lead | Create tasks to clarify and determine velocity | +| [Backlog refinement](../backlog-management/README.md) | Wednesday 2PM | 1 hour | Dev Lead, PO | PO | Prepare for next sprint and ensure that stories are ready for next sprint. | ## Process Lead diff --git a/docs/code-reviews/recipes/markdown.md b/docs/code-reviews/recipes/markdown.md index e354919b3f..9c10bcda3a 100644 --- a/docs/code-reviews/recipes/markdown.md +++ b/docs/code-reviews/recipes/markdown.md @@ -171,7 +171,7 @@ Save your guidelines together with your documentation, so they are easy to refer ### Document Organization - Organize documents by topic rather than type, this makes it easier to find the documentation -- Each folder should have a top-level readme.md and any other documents within that folder should link directly or indirectly from that readme.md +- Each folder should have a top-level README.md and any other documents within that folder should link directly or indirectly from that README.md - Document names with more than one word should use underscores instead of spaces, for example `machine_learning_pipeline_design.md`. The same applies to images ### Headings diff --git a/docs/design/design-reviews/recipes/engagement-process.md b/docs/design/design-reviews/recipes/engagement-process.md index f3b285e026..e4f6a84484 100644 --- a/docs/design/design-reviews/recipes/engagement-process.md +++ b/docs/design/design-reviews/recipes/engagement-process.md @@ -37,7 +37,7 @@ Stories that will benefit from design reviews have one or more of the following ## Sprint Backlog Refinement -If your team is not already hosting a [Sprint Backlog Refinement](../../../agile-development/advanced-topics/backlog-management/readme.md) session at least once per week you should consider it. It is a great opportunity to: +If your team is not already hosting a [Sprint Backlog Refinement](../../../agile-development/advanced-topics/backlog-management/README.md) session at least once per week you should consider it. It is a great opportunity to: 1. Keep the backlog clean 1. Re-prioritize work based on shifting business priorities diff --git a/docs/documentation/recipes/using-docfx-and-tools.md b/docs/documentation/recipes/using-docfx-and-tools.md index 7f43d8f314..aa77d60d1b 100644 --- a/docs/documentation/recipes/using-docfx-and-tools.md +++ b/docs/documentation/recipes/using-docfx-and-tools.md @@ -193,7 +193,7 @@ You can add specific links that are important to provide direct access. > Try not to duplicate the links on the top of the page, unless it really makes sense. -To get started with the setup of this website, read the getting started document with the title [Using DocFx and Companion Tools](docs/getting-started/readme.md). +To get started with the setup of this website, read the getting started document with the title [Using DocFx and Companion Tools](using-docfx-and-tools.md). ``` diff --git a/docs/machine-learning/ml-project-management.md b/docs/machine-learning/ml-project-management.md index f7a67b5264..5afcf419b4 100644 --- a/docs/machine-learning/ml-project-management.md +++ b/docs/machine-learning/ml-project-management.md @@ -13,7 +13,7 @@ To learn more about how CSE runs the Agile process for software development team Within this framework, the team follows these Agile ceremonies: -- [Backlog management](../agile-development/advanced-topics/backlog-management/readme.md) +- [Backlog management](../agile-development/advanced-topics/backlog-management/README.md) - [Retrospectives](../agile-development/core-expectations/README.md) - [Scrum of Scrums](../agile-development/advanced-topics/effective-organization/scrum-of-scrums.md) (where applicable) - [Sprint planning](../agile-development/core-expectations/README.md) diff --git a/docs/source-control/git-guidance/README.md b/docs/source-control/git-guidance/README.md index cb00ec994f..0256918f68 100644 --- a/docs/source-control/git-guidance/README.md +++ b/docs/source-control/git-guidance/README.md @@ -105,7 +105,7 @@ To avoid losing work, it is good to commit often in small chunks. This allows yo Changes not staged for commit: (use "git add ..." to update what will be committed) (use "git restore ..." to discard changes in working directory) - modified: source-control/git-guidance/readme.md + modified: source-control/git-guidance/README.md ``` 3. Track the files you wish to include in the commit. To track all modified files: @@ -117,7 +117,7 @@ To avoid losing work, it is good to commit often in small chunks. This allows yo Or to track only specific files: ```cmd - git add source-control/git-guidance/readme.md + git add source-control/git-guidance/README.md ``` 4. Commit the changes to your local branch with a descriptive [commit message](../README.md#commit-best-practices)