This guide will walk you through the first few steps of the GitHub workflow, forking the repository to your laptop, ready to create content within vscode.
Git veterans can freely skip this page!
You will need to have met the core vscode prereqs to be able to upload:
- Visual Studio Code
- Bash on Ubuntu configured as the Integrated Console (Terminal)
1. Fork the repo
You will need to create your own GitHub ID if you do not already have one.
If you create a new GitHub ID then there is no need to add a new repository as we will be forking the Citadel repo in the next step.
- Go to https://github.com/azurecitadel/azurecitadel.github.io
- Click on the fork button at the top right of the screen
- This will copy the main repository into your GitHub account
- It will also retain a link back to the main repo
- You will now be in your fork- if you look at the browser address bar then the URL will be in the format
- Copy the URL in the address bar (
We will use this in the next step.
2. Clone within vscode
You can then clone the repository:
- Open vscode
- Open the Command Palette (
- You will be prompted to enter the Repository URL
- Paste in the URL for your fork of the repo that you copied from the address bar
- You will be prompted to choose the destination directory
- It is common to have one git folder for your repos
- Wait until the repo has cloned
- You will see a toast notification once the cloning has completed
- You’ll be prompted to either Open or Open in New Windows
- Click Open
3. Add azurecitadel as the upstream
You’ll need to add azurecitadel as your upstream to request your changes to be pulled into the main repo later.
We’ll run a few commands in the Terminal (which used to be called the integrated console). You can open the Terminal from the menu using Terminal –> New Terminal, or use the
' keyboard shortcut.
- See that your current git remote is the origin using the following command:
git remote -v
origin https://github.com/richeney/azurecitadel.github.io (fetch) origin https://github.com/richeney/azurecitadel.github.io (push)
- Add the main repo as the upstream:
git remote add upstream http://github.com/azurecitadel/azurecitadel.github.io
- Check it is now in the list of remotes:
git remote -v
origin https://github.com/richeney/azurecitadel.github.io (fetch) origin https://github.com/richeney/azurecitadel.github.io (push) upstream https://github.com/azurecitadel/azurecitadel.github.io (fetch) upstream https://github.com/azurecitadel/azurecitadel.github.io (push)
You now have both the origin (to your fork) and the upstream (to the azurecitadel repo itself).
Before working on files, it is always a good idea to pull down any updates in the upstream. Click on the ellipsis (…) in the Source Control sidebar (CTRL-SHIFT-G) and select Pull from…. Select the upstream, and then the master branch.
You are now ready to create content. If this is the first time you have contributed then you should add yourself as an author first, so click that link.
(If you are already listed in the authors.yml then you can fast forward to the Content page.)