This tutorial will provide the instructions that you need to follow to upload one group assignment to the Fab Lab Oulu Fabacademy site.

The GIT project is called site and can be cloned from this url: git@gitlab.fabcloud.org:academany/fabacademy/2024/labs/oulu/site.git.

NOTE: you are going to use a repository different to your personal one (named site repository).

Please, be extremely careful when you use the site repository because you are sharing it with other people.

Additionally you should notice that you cannot push to the master branch so you will work in an alternative branch. Instructors will make a merge when your site is ready, so the page is published.

You should also be aware that you are not going to see the changes in the Fabacademy Oulu site till one of the instructors merge your branch with the main branch.

Instructions for working in group weekly assignment

1. Clone the repo (just once). Remember that this repo is different than your portfolio repository, so it should be stored in a different folder.

    git clone git@gitlab.fabcloud.org:academany/fabacademy/2024/labs/oulu/site.git

2. Open a terminal and access the root of the siterepository using cd commands.

3. Pull data from the remote repo to your local repo

    git pull origin main

4. Each group should create a new branch. You should agree the name of the branch with your group partners.

If no one has yet created the team's branch

1. Check that no one has yet create the branch. Following command will list the remote branches

    git remote show origin

2. Create a new branch. You can name it as you wish. Recommendation: name_of_the_assignment_group1 or name_of_the_assignment_group2

    git checkout -b *name_of_the_branch*

3. Check that you are in the right branch:

    git status

4. Before continuing is recommended to make a pull. Notice that you are now pulling from the branch name_of_the_branch and not to the master branch. This pull should fail because the branch does not exist yet in the remote. Otherwise, it means someone else has already created the branch.

    git pull origin *name_of_the_branch*

5. Do the commits normally:

   git add --all
   git commit -m "commit message"

6. Now do the pushing. Notice that you are now pushing to the branch name_of_the_branch and not to the master branch. Note also the -u necessary to create a remote branch for tracking. This is necessary only the first time that you push the new branch.

     git push -u origin *name_of_the_branch*

If one of the group members has already created the branch

1. Check that the branch is in the remote repo. Following command will list the remote branches

    git remote show origin

2. Start working with the remote branch.

    git fetch
    git checkout  *name_of_the_branch*

3. Check that you are in the right branch:

    git status

4. Before continuing is recommended to make a pull. Notice that you are now pulling from the branch name_of_the_branch and not to the master branch. At this stage you might need to solve conflicts. If you need help ask the instructors. More info on how to solve conflicts in this tutorial

    git pull origin *name_of_the_branch*

5. Do the commits normally:

   git add --all
   git commit -m "commit message"

6. Now you can do a push. Notice that you are now pushing and pulling to the branch name_of_the_branch and not to the master branch.

     git push origin *name_of_the_branch*

How to edit your machine's assignment

• The assignment must follow mkdocs, so you need to edit the file using markdown.
• Access the docs\machine_projects\{your_team} folder.
• Edit the .mdfile
• Static files such images or source code should be stored in docs\machine_projects\{your_team}\assets`
• In order to add the image please be sure that you use relative paths: ![Testing and image](assets/img/{image_name})]

Once you want to merge your group documentation with the main branch (so it is presented in the site)

You need to report to the course staff that the branch is ready for merging with master and hence to be published in the website.

1. Be sure that you have pushed the last version of the branch.

    git push origin *name_of_the_branch*

2. Open the browser and go to the Gitlab site project: https://gitlab.fabcloud.org/academany/fabacademy/2024/labs/oulu/site

3. Go to Code > Merge Requestsin the left menu

4. From the list select the element that reads:

    You pushed to *name_of_the_branch* xx minutes ago

Press create merge request button

5. Give a title (e.g. Machine project description) and description to the merge request. Press the Submit merge request button
6. Instructors will merge the request with the main branch as soon as possible. You will not see the changes in the website until the merging is finalized