Skip to content

Commit a0a1c5d

Browse files
Use reference links for improved clarity and consistency
1 parent 02d5a13 commit a0a1c5d

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

content/1-hour/0-setup.md

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

3-
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](https://docs.github.com/en/get-started/quickstart/fork-a-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](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository). Template repositories are a great way to provide starters for your organization, ensuring consistency across projects.
3+
| [← Getting started with GitHub Copilot][walkthrough-previous] | [Next: Coding with GitHub Copilot →][walkthrough-next] |
4+
|:-----------------------------------|------------------------------------------:|
5+
6+
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.
47

58
The repository for this workshop is configured as a template, so we can use it to create your repository.
69

710
> [!IMPORTANT]
8-
> Ensure you have the [requisite software](./README.md#required-local-installation) and [requisite resources](./README.md#required-resources) setup.
11+
> Ensure you have the [requisite software][required-software] and [requisite resources][required-resources] setup.
912
1013
## Create your repository
1114

@@ -51,8 +54,8 @@ With the repository created, it's now time to clone the repository locally. We'l
5154

5255
The startup script will start two applications:
5356

54-
- The backend Flask app on [localhost:5100](http://localhost:5100). You can see a list of dogs by opening the [dogs API](http://localhost:5100/api/dogs).
55-
- The frontend Astro/Svelte app on [localhost:4321](http://localhost:4321). You can see the [website](http://localhost:4321) by opening that URL.
57+
- The backend Flask app on [localhost:5100][flask-url]. You can see a list of dogs by opening the [dogs API][dogs-api].
58+
- The frontend Astro/Svelte app on [localhost:4321][astro-url]. You can see the [website][website-url] by opening that URL.
5659

5760
## Open your editor
5861

@@ -65,6 +68,19 @@ With the code cloned locally, and the site running, let's open the codebase up i
6568
6669
## Summary and next steps
6770
68-
You've now cloned the repository you'll use for this workshop and have your IDE setup! Next let's [add a new endpoint to the server](./1-add-endpoint.md)!
71+
You've now cloned the repository you'll use for this workshop and have your IDE setup! Next let's [add a new endpoint to the server][walkthrough-next]!
72+
73+
74+
| [← Getting started with GitHub Copilot][walkthrough-previous] | [Next: Coding with GitHub Copilot →][walkthrough-next] |
75+
|:-----------------------------------|------------------------------------------:|
6976

70-
**NEXT:** [Exercise 1: Add an endpoint](./1-add-endpoint.md)
77+
[astro-url]: http://localhost:4321
78+
[dogs-api]: http://localhost:5100/api/dogs
79+
[flask-url]: http://localhost:5100
80+
[fork-repo]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
81+
[required-resources]: ./README.md#required-resources
82+
[required-software]: ./README.md#required-local-installation
83+
[template-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository
84+
[walkthrough-previous]: README.md
85+
[walkthrough-next]: ./1-add-endpoint.md
86+
[website-url]: http://localhost:4321

0 commit comments

Comments
 (0)