Skip to content

docs: prioritise dev containers and cleanup git config instructions #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
anaghwadhwa123 wants to merge 1 commit into from
Closed

docs: prioritise dev containers and cleanup git config instructions #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 36 additions & 35 deletions src/content/docs/setup/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,22 @@ title: Initial Setup
- Ensure you have access to the **Thoth Tech** Microsoft Teams Channel. If not, please contact Morgaine so she can add you to the channel.
- Navigate to the **OnTrack** channel.
- Open the **OnTrack Planner Board** tab at the top to view and assign yourself to active tasks.
- If you cannot see the board, contact Brain Dang to be added to the cohort's workspace.
- If you cannot see the board, contact Brian Dang to be added to the cohort's workspace.

## Configuring git (global)
## Configuring Git (Global)

If you haven’t already, you must configure git.
If this is your first time using Git on this machine, you must configure your identity. This information is attached to every commit you make.

1. Set your git username by git config –global user.name “FIRST_NAME LAST_NAME”, whereFIRST_NAME is your first name and LAST_NAME is your last name.
2. Set your git email by git config –global user.email “YOUR_EMAIL”, where YOUR_EMAIL is your email. It is advised that you use your @users.noreply.github.com email address, which is, by default, <username>@users.noreply.github.com, where <username> is your GitHub username.
1. **Set your name:**
```bash
git config --global.username "Your Name"
2. **Set your email:**
```bash
git config --global user.email "username@users.noreply.github.com"

:::note[Privacy Tip]
Using your GitHub-provided noreply email address keeps your personal email private in the public commit history. You can find your specific address in your GitHub Email Settings.
:::

## Cloning the Documentation

Expand All @@ -24,40 +32,37 @@ Terminal window

git clone https://github.com/thoth-tech/doubtfire-astro.git

## WSL2

If you are on a Windows machine, then we recommend that you install WSL2.

## Get OnTrack Running on Local Machine

You need a terminal that supports shell scripts (on Windows, you need WSL2, Msys2, or Cygwin).

1. Fork [doubtfire-deploy](https://github.com/doubtfire-lms/doubtfire-deploy), [doubtfire-api](https://github.com/doubtfire-lms/doubtfire-api), and [doubtfire-web](https://github.com/doubtfire-lms/doubtfire-web)
2. Clone your [doubtfire-deploy](https://github.com/doubtfire-lms/doubtfire-deploy). Make sure to fetch submodules to get the sub-projects.
There are two ways to set up the project. We **strongly recommend** Option 1 for the most consistent experience.

Terminal window

git clone –recurse-submodules <https://github.com/YOUR_USERNAME/doubtfire-deploy>
### Option 1: VS Code Dev Containers (Recommended)

1. cd into the directory.
:::tip[Why choose this?]
This is the fastest setup method. It automatically configures Docker, Ruby, and Node.js inside a pre-set container, preventing almost all "it works on my machine" errors.
:::

Terminal window
1. **Prerequisites:** Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) and the [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in VS Code.
2. **Fork & Clone:** Fork and clone the 'doubtfire-deploy' repository as described in the Manual Setup below.
3. **Launch:** Open the folder in VS Code. When the pop-up appears in the bottom right, click **"Reopen in Container"**.
4. **Wait:** VS Code will build the environment. Once finished, you are ready to develop!

cd doubtfire-deploy
### Option 2: Manual Local Setup

1. Open a terminal that supports sh scripts (on Windows, you require WSL2, Msys2, or Cygwin). Run the following command to set your fork as the remote.
Use this method if you prefer to manage dependencies (Ruby, Node, etc.) directly on your host machine. **Note:** On Windows, you will need a terminal that supports shell scripts (WSL2, MSYS2, or Cygwin).

Terminal window
1. **Fork the repositories:** Fork [doubtfire-deploy](https://github.com/thoth-tech/doubtfire-deploy), [doubtfire-api](https://github.com/thoth-tech/doubtfire-api), and [doubtfire-web](https://github.com/thoth-tech/doubtfire-web).
2. **Clone with Submodules:**
```bash
git clone --recurse submodules [https://github.com/YOUR_USERNAME/doubtfire-deploy](https://github.com/YOUR_USERNAME/doubtfire-deploy)
cd doubtfire-deploy
3. **Configure Remotes:** Run the following command to set your fork as the remote:
```bash
./change_remotes.sh
```
4. **Add Team Remote:** Use the username provided by your Mentor: git remote add task-view-submission [https://github.com/PROVIDED_USERNAME/doubtfire-deploy](https://github.com/PROVIDED_USERNAME/doubtfire-deploy)
5. **Final Steps:** Follow the remaining instructions in the [doubtfire-deploy contributing file](https://github.com/doubtfire-lms/doubtfire-deploy/blob/development/CONTRIBUTING.md#working-with-docker-compose).

./change_remotes.sh

1. Your delivery lead provides you with the GitHub username to use in this command. This allows you to use git fetch task-view-submission, git pull task-view-submission, and git push task-view-submission.

Terminal window

git remote add task-view-submission <https://github.com/PROVIDED_USERNAME/doubtfire-deploy>

1. You can now follow the remaining instructions, from instruction four, in the doubtfire-deploy [contributing file](https://github.com/doubtfire-lms/doubtfire-deploy/blob/development/CONTRIBUTING.md#working-with-docker-compose).

## What Next?

Expand All @@ -74,8 +79,4 @@ Now that your environment is set up, familiarise yourself with the current proje
## Technical & Specialised Tasks

- **Security & Databases:** If you have specialised knowledge in cyber-security or database adminstration, check the specialised tasks on the Planner board for implementation reviews.
- **Git Integration:** Examine how Git can be better implemented on the back-end of the OnTrack product as part of the current sprint.

## Helpful Points

- If you are using Windows as your primary operating system and you have not downloaded, installed, and/or set-up MinGW, then a former team found the Linux subsystem [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/install) and [Docker Desktop WSL 2 backend](https://docs.docker.com/desktop/windows/wsl/) as a helpful development environment.
- **Git Integration:** Examine how Git can be better implemented on the back-end of the OnTrack product as part of the current sprint.
Loading