Skip to content

Commit 6e5b4a0

Browse files
committed
Updated links
1 parent ba6aa68 commit 6e5b4a0

File tree

9 files changed

+87
-84
lines changed

9 files changed

+87
-84
lines changed

content/0-setup.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Workshop setup
22

3-
| [← Modern DevOps with GitHub][walkthrough-previous] | [Next: Enable Code Scanning →][walkthrough-next] |
3+
| [← Modern DevOps with GitHub][previous] | [Next: Enable Code Scanning →][next] |
44
|:-----------------------------------|------------------------------------------:|
55

66
To complete this workshop you will need to create a repository with a copy of the contents of this repository. While this can be done by [forking a repository][fork-repo], the goal of a fork is to eventually merge code back into the original (or upstream) source. In our case we want a separate copy as we don't intend to merge our changes. This is accomplished through the use of a [template repository][template-repo]. Template repositories are a great way to provide starters for your organization, ensuring consistency across projects.
@@ -22,13 +22,14 @@ Let's create the repository you'll use for your workshop.
2222
In a few moments a new repository will be created from the template for this workshop!
2323

2424
## Summary and next steps
25-
You've now created the repository you'll use for this workshop! Next let's [enable Code Scanning][walkthrough-next] to secure the code we write.
25+
You've now created the repository you'll use for this workshop! Next let's [enable Code Scanning][next] to secure the code we write.
2626

27-
| [← Modern DevOps with GitHub][walkthrough-previous] | [Next: Enable Code Scanning →][walkthrough-next] |
27+
| [← Modern DevOps with GitHub][previous] | [Next: Enable Code Scanning →][next] |
2828
|:-----------------------------------|------------------------------------------:|
2929

30+
[next]: ./1-code-scanning.md
31+
[previous]: ./README.md
32+
3033
[fork-repo]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
31-
[template-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository
3234
[repo-root]: /
33-
[walkthrough-previous]: README.md
34-
[walkthrough-next]: 1-code-scanning.md
35+
[template-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository

content/1-code-scanning.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Securing the development pipeline
22

3-
| [← Workshop setup][walkthrough-previous] | [Next: Project management with GitHub Issues →][walkthrough-next] |
3+
| [← Workshop setup][previous] | [Next: Project management with GitHub Issues →][next] |
44
|:-----------------------------------|------------------------------------------:|
55

66
Ensuring code security is imperative in today's environment. When we think about how we create code today, there's three main areas to focus on:
@@ -84,25 +84,26 @@ A background process starts, and will configure a workflow for analyzing your co
8484

8585
## Summary and next steps
8686

87-
In this exercise, you enabled GitHub Advanced Security. You enabled Dependabot to check the libraries your project takes dependencies on, secret scanning to look for keys and tokens, and code scanning to examine your source code. These tools help ensure your application is secure. Next it's time to [file an issue][walkthrough-next] to add feature requests.
87+
In this exercise, you enabled GitHub Advanced Security. You enabled Dependabot to check the libraries your project takes dependencies on, secret scanning to look for keys and tokens, and code scanning to examine your source code. These tools help ensure your application is secure. Next it's time to [file an issue][next] to add feature requests.
8888

8989
### Additional resources
9090

9191
- [About GitHub Advanced Security][advanced-security-docs]
9292
- [GitHub Skills: Secure your repository's supply chain][skills-supply-chain]
9393
- [GitHub Skills: Secure code game][skills-secure-code]
9494

95-
| [← Workshop setup][walkthrough-previous] | [Next: Project management with GitHub Issues →][walkthrough-next] |
95+
| [← Workshop setup][previous] | [Next: Project management with GitHub Issues →][next] |
9696
|:-----------------------------------|------------------------------------------:|
9797

98-
[advanced-security]: https://github.com/features/security
99-
[advanced-security-docs]: https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security
98+
[next]: ./2-issues.md
99+
[previous]: ./0-setup.md
100+
100101
[about-code-scanning]: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
101102
[about-prs]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
103+
[advanced-security]: https://github.com/features/security
104+
[advanced-security-docs]: https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security
102105
[dependabot-quickstart]: https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide
103106
[github-actions]: https://github.com/features/actions
104-
[supported-secrets]: https://docs.github.com/en/code-security/secret-scanning/secret-scanning-patterns#supported-secrets
105-
[skills-supply-chain]: https://github.com/skills/secure-repository-supply-chain
106107
[skills-secure-code]: https://github.com/skills/secure-code-game
107-
[walkthrough-previous]: 0-setup.md
108-
[walkthrough-next]: 2-issues.md
108+
[skills-supply-chain]: https://github.com/skills/secure-repository-supply-chain
109+
[supported-secrets]: https://docs.github.com/en/code-security/secret-scanning/secret-scanning-patterns#supported-secrets

content/2-issues.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Project management with GitHub Issues
22

3-
| [← Securing the development pipeline][walkthrough-previous] | [Next: Cloud-based development with GitHub Codespaces →][walkthrough-next] |
3+
| [← Securing the development pipeline][previous] | [Next: Cloud-based development with GitHub Codespaces →][next] |
44
|:-----------------------------------|------------------------------------------:|
55

66
"URL or it didn't happen" is a common mantra at GitHub, which is used to highlight the importance of documenting the development process. Feature requests should have a history: who made the request, what was the rationale, who was involved in the process, what decisions were made, why were they made, was the feature implemented, how was it implemented... All of this information helps provide context to both drive future decisions and avoid repeating old mistakes.
@@ -55,23 +55,24 @@ You've now defined all the issues for the workshop! You'll use these issues to h
5555

5656
## Summary and next steps
5757

58-
GitHub Issues are the core to project management on GitHub. Their flexibility allows your organization to determine the best course of action to support your development lifecycle's methodology. With your issues created, it's time to turn your attention to the first big change to the project, [defining a codespace][walkthrough-next].
58+
GitHub Issues are the core to project management on GitHub. Their flexibility allows your organization to determine the best course of action to support your development lifecycle's methodology. With your issues created, it's time to turn your attention to the first big change to the project, [defining a codespace][next].
5959

6060
## Resources
6161

6262
- [GitHub Issues][issues-docs]
6363
- [Communicate using markdown][skills-markdown]
6464
- [GitHub Projects][projects-docs]
6565

66-
| [← Securing the development pipeline][walkthrough-previous] | [Next: Cloud-based development with GitHub Codespaces →][walkthrough-next] |
66+
| [← Securing the development pipeline][previous] | [Next: Cloud-based development with GitHub Codespaces →][next] |
6767
|:-----------------------------------|------------------------------------------:|
6868

69-
[discussions]: https://github.com/features/discussions
70-
[wikis]: https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis
69+
[next]: ./3-codespaces.md
70+
[previous]: ./1-code-scanning.md
71+
7172
[about-prs]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
73+
[discussions]: https://github.com/features/discussions
7274
[issues]: https://github.com/features/issues
7375
[issues-docs]: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues
7476
[projects-docs]: https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects
7577
[skills-markdown]: https://github.com/skills/communicate-using-markdown
76-
[walkthrough-next]: 3-codespaces.md
77-
[walkthrough-previous]: 1-code-scanning.md
78+
[wikis]: https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis

content/3-codespaces.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cloud-based development with GitHub Codespaces
22

3-
| [← Project management with GitHub Issues][walkthrough-previous] | [Next: Continuous integration and testing →][walkthrough-next] |
3+
| [← Project management with GitHub Issues][previous] | [Next: Continuous integration and testing →][next] |
44
|:-----------------------------------|------------------------------------------:|
55

66
One of the biggest challenges organizations face is onboarding new developers to projects. There are libraries to install, services to configure, version issues, obscure error messages... It can literally take days to get everything running before a developer is able to write their first line of code.
@@ -129,7 +129,7 @@ Whenever someone uses the codespace you defined they'll have an environment with
129129

130130
## Interacting with the repository
131131

132-
Custom containers for GitHub Codespaces become part of the source code for the repository. Thus they are maintained through standard source control, and will follow the repository as it's forked in the future. This allows this definition to be shared across all developers contributing to the project. Let's upload our new configuration, closing the [issue you created][walkthrough-previous] for defining a development environment.
132+
Custom containers for GitHub Codespaces become part of the source code for the repository. Thus they are maintained through standard source control, and will follow the repository as it's forked in the future. This allows this definition to be shared across all developers contributing to the project. Let's upload our new configuration, closing the [issue you created][previous] for defining a development environment.
133133

134134
> [!IMPORTANT]
135135
> For purposes of this exercise we are pushing code updates directly to `main`, our default branch. Normally you would follow the [GitHub flow][github-flow], which we will do in a [later exercise][github-flow-exercise].
@@ -165,7 +165,7 @@ Custom containers for GitHub Codespaces become part of the source code for the r
165165

166166
## Summary and next steps
167167

168-
Congratulations! You have now defined a custom development environment including all services and extensions. This eliminates the initial setup hurdle normally required when contributing to a project. Let's use this codespace to [implement testing and continuous integration][walkthrough-next] for the project.
168+
Congratulations! You have now defined a custom development environment including all services and extensions. This eliminates the initial setup hurdle normally required when contributing to a project. Let's use this codespace to [implement testing and continuous integration][next] for the project.
169169

170170
## Resources
171171

@@ -174,23 +174,24 @@ Congratulations! You have now defined a custom development environment including
174174
- [Defining dev containers][dev-containers-docs]
175175
- [GitHub Skills: Code with Codespaces][skills-codespaces]
176176

177-
| [← Project management with GitHub Issues][walkthrough-previous] | [Next: Continuous integration and testing →][walkthrough-next] |
177+
| [← Project management with GitHub Issues][previous] | [Next: Continuous integration and testing →][next] |
178178
|:-----------------------------------|------------------------------------------:|
179179

180+
[next]: ./4-continuous-integration.md
181+
[previous]: ./2-issues.md
182+
[github-flow-exercise]: ./6-github-flow.md
183+
184+
[codespace-prebuild]: https://docs.github.com/en/codespaces/prebuilding-your-codespaces
180185
[codespaces]: https://github.com/features/codespaces
186+
[codespaces-docs]: https://docs.github.com/en/codespaces/overview
181187
[codespaces-forward-ports]: https://docs.github.com/en/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace
182188
[copilot-extension]: https://marketplace.visualstudio.com/items?itemName=GitHub.copilot
183-
[codespaces-docs]: https://docs.github.com/en/codespaces/overview
184-
[codespace-prebuild]: https://docs.github.com/en/codespaces/prebuilding-your-codespaces
185189
[dev-containers-docs]: https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers
186190
[github-flow]: https://docs.github.com/en/get-started/quickstart/github-flow
187-
[github-flow-exercise]: ./7-github-flow.md
188191
[github-universal-container]: https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration
189192
[github-universal-container-definition]: https://github.com/devcontainers/images/blob/main/src/universal/.devcontainer/Dockerfile
190193
[IDE]: https://en.wikipedia.org/wiki/Integrated_development_environment
191194
[skills-codespaces]: https://github.com/skills/code-with-codespaces
192195
[vscode-codespaces]: https://docs.github.com/en/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code
193196
[vscode-extensions]: https://code.visualstudio.com/docs/editor/extension-marketplace
194197
[vscode-post-start-command]: https://code.visualstudio.com/remote/advancedcontainers/start-processes
195-
[walkthrough-previous]: 2-issues.md
196-
[walkthrough-next]: 4-testing.md

content/4-continuous-integration.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Continuous integration and testing
22

3-
| [← Cloud-based development with GitHub Codespaces][walkthrough-previous] | [Next: Helping GitHub Copilot understand context ][walkthrough-next] |
3+
| [← Cloud-based development with GitHub Codespaces][previous] | [Next: Coding with GitHub Copilot →][next] |
44
|:-----------------------------------|------------------------------------------:|
55

66
Chances are you've heard the abbreviation CI/CD, which stands for continuous integration and continuous delivery (or sometimes continuous deployment). CI is centered on incorporating new code into the existing codebase, and typically includes running tests and performing builds. CD focuses on the next logical step, taking the now validated code and generating the necessary outputs to be pushed to the cloud or other destinations. This is probably the most focused upon component of DevOps.
@@ -141,7 +141,7 @@ You've now seen a workflow, and explore the details of a run!
141141

142142
## Summary and next steps
143143

144-
Congratulations! You've implemented automated testing, a standard part of continuous integration, which is critical to successful DevOps. Automating these processes ensures consistency and reduces the workload required for developers and administrators. You have created a workflow to run tests on any new code for your codebase. Let's explore [context with GitHub Copilot chat][walkthrough-next].
144+
Congratulations! You've implemented automated testing, a standard part of continuous integration, which is critical to successful DevOps. Automating these processes ensures consistency and reduces the workload required for developers and administrators. You have created a workflow to run tests on any new code for your codebase. Let's explore [coding with GitHub Copilot][next].
145145

146146
### Resources
147147

@@ -150,19 +150,20 @@ Congratulations! You've implemented automated testing, a standard part of contin
150150
- [About continuous integration][about-ci]
151151
- [GitHub Skills: Test with Actions][skills-test-actions]
152152

153-
| [← Cloud-based development with GitHub Codespaces][walkthrough-previous] | [Next: Helping GitHub Copilot understand context →][walkthrough-next] |
153+
| [← Cloud-based development with GitHub Codespaces][previous] | [Next: Coding with GitHub Copilot →][next] |
154154
|:-----------------------------------|------------------------------------------:|
155155

156+
[next]: ./5-code.md
157+
[previous]: ./3-codespaces.md
158+
[github-flow-exercise]: ./6-github-flow.md
159+
[issues-exercise]: ./2-issues.md
160+
156161
[about-ci]: https://docs.github.com/en/actions/automating-builds-and-tests/about-continuous-integration
157162
[about-prs]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
158163
[actions-marketplace]: https://github.com/marketplace?type=actions
159-
[workflow-triggers]: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
160164
[copilot]: https://gh.io/copilot
161165
[copilot-slash-commands]: https://docs.github.com/en/copilot/using-github-copilot/copilot-chat/github-copilot-chat-cheat-sheet
162166
[github-actions]: https://github.com/features/actions
163167
[github-flow]: https://docs.github.com/en/get-started/quickstart/github-flow
164-
[github-flow-exercise]: ./7-github-flow.md
165-
[issues-exercise]: ./2-issues.md
166168
[skills-test-actions]: https://github.com/skills/test-with-actions
167-
[walkthrough-previous]: 3-codespaces.md
168-
[walkthrough-next]: 5-context.md
169+
[workflow-triggers]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

0 commit comments

Comments
 (0)