Skip to content

Commit 3869cfc

Browse files
committed
Update README.md to enhance clarity and structure of workshop instructions
1 parent 6ed542d commit 3869cfc

File tree

1 file changed

+12
-30
lines changed

1 file changed

+12
-30
lines changed

content/guided-workshop/README.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,28 @@ This workshop is built to help guide you through some of the most common DevOps
88
- Creating a development environment with [GitHub Codespaces](https://github.com/features/codespaces)
99
- Using [GitHub Copilot](https://github.com/features/copilot) as your AI pair programmer
1010
- Securing the development pipeline with [GitHub Advanced Security](https://github.com/features/security)
11-
- Automating provisioning and deployment with [GitHub Actions](https://github.com/features/actions)
11+
- Automating tasks and CI/CD with [GitHub Actions](https://github.com/features/actions)
1212

1313
## Prerequisites
1414

15-
This workshop assumes you are familiar with:
16-
17-
- development, however strong coding skills are not required (solution files are provided).
18-
- the cloud, and how resources can be hosted by different providers.
15+
The application for the workshop uses is built primarily with Python (Flask and SQLAlchemy) and Astro (using Tailwind and Svelte). While experience with these frameworks and languages is helpful, you'll be using Copilot to help you understand the project and generate the code. As a result, as long as you are familiar with programming you'll be able to complete the exercises!
1916

2017
## Required resources
2118

2219
To complete this workshop, you will need the following:
2320

2421
- A [GitHub account](https://github.com/join)
25-
- An [Azure account](https://azure.microsoft.com/en-us/free/) if you wish to deploy your project
26-
27-
### Cloud consumption
28-
29-
This workshop does use both GitHub and (optionally) Azure cloud services. Below is the information you will need about potential costs:
30-
31-
- The GitHub Security and GitHub Actions features used during this workshop are at levels which are free for public repositories.
32-
- When using GitHub Codespaces, you have 60 free core hours available which will be more than sufficient for most learners.
33-
- GitHub Copilot does require a subscription, however a [free trial for GitHub Copilot](https://docs.github.com/en/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot) is available. The coding exercise does not require the use of GitHub Copilot.
34-
- If you choose to deploy to Azure (the last two exercises), there is a cost of around $6 US. This amount is covered by creating a new [Azure account](https://azure.microsoft.com/en-us/free/).
22+
- Access to [GitHub Copilot](https://github.com/features/copilot)
3523

3624
## Getting started
3725

38-
Ready to get started? Let's go! The workshop scenario imagines you as a developer volunteering your time for a pet adoption center. You will work through the process of creating a development environment, creating code, enabling security, automating processes, and optionally deploying the project.
39-
40-
0. [Setup your environment](exercises/0-setup.md) for the workshop
41-
1. [Enable Code Scanning](exercises/1-code-scanning.md) to ensure new code is secure
42-
2. [Create an issue](exercises/2-issues.md) to document a feature request
43-
3. [Create a codespace](exercises/3-codespaces.md) to start writing code
44-
4. [Implement testing](exercises/4-testing.md) to supplement continuous integration
45-
5. [Add code with the help of GitHub Copilot](exercises/5-coding.md) to implement the feature
46-
6. [Use the GitHub flow](exercises/6-github-flow.md) to incorporate changes
47-
48-
If you wish, you can also close out your DevOps learning journey by deploying to the cloud. For purposes of this workshop, Azure is used, however the concepts are applicable to any cloud provider.
49-
50-
> **NOTE:** When deploying to a cloud environment, some charges may be incurred. For this workshop, when deploying to Azure and deleting the resources upon completion of the exercises, the charge should be less than $6 US.
26+
Ready to get started? Let's go! The workshop scenario imagines you as a developer volunteering your time for a pet adoption center. You will work through the process of creating a development environment, creating code, enabling security, and automating processes.
5127

52-
7. [Add automation](exercises/7-automation.md) to create a deployment environment
53-
8. [Deploy your project](exercises/8-deployment.md) to publish your project to the cloud
28+
1. [Setup your environment](exercises/0-setup.md) for the workshop
29+
2. [Enable Code Scanning](exercises/1-code-scanning.md) to ensure new code is secure
30+
3. [Create an issue](exercises/2-issues.md) to document a feature request
31+
4. [Create a codespace](exercises/3-codespaces.md) to start writing code
32+
5. [Implement testing](exercises/4-testing.md) to supplement continuous integration
33+
6. [Provide Copilot context](exercises/5-context.md) to generate quality code suggestions
34+
7. [Add features to your app](exercises/6-code.md) with GitHub Copilot
35+
8. [Use the GitHub flow](exercises/6-github-flow.md) to incorporate changes into your codebase

0 commit comments

Comments
 (0)