Commit 7943c33a authored by Rami Alshafi's avatar Rami Alshafi

Merge branch '5-do-not-need-landing-page-screen-shot' into 'master'

Resolve "Do not need landing page screen shot"

Closes #5

See merge request rami/docs!6
parents 723d2437 79d3cfa7
# Creating an account
Please visit [gitlab.iotivity.org](https://gitlab.iotivity.org) and click on the "Register" tab and fillout your information and click on the "Register" green button once done. An e-mail wil lbe sent to you which might end up in the junk mail so please check your junk mail. In the sent e-mail, there will be a link to click taking you back to the log in page where you can enter your username and password and sign in.
![Registration page](/assets/landing_page.PNG)
Visit [gitlab.iotivity.org](https://gitlab.iotivity.org)
- click on the "Register" tab
- fill in your information
- click on the green "Register" button
- check your e-mail for a registation e-mail
- follow link from e-email to the log in page
- enter your username and password to sign in
The e-mail might end up in the junk mail, please check your junk
mail.
# Requesting Access
Once the account has been created, you will need to request access to the groups and projects you would like to be part of.
To request access for the IoTivity group for example, open the IoTivity group page and there should be a link underneath the group name labeled as `Request access`.
Once the account has been created, you will need to request access to the groups
and projects you would like to be part of.
To request access for the IoTivity group for example, open the IoTivity group
page. There should be a link underneath the group name labeled as `Request access`.
![AR link](/assets/request_access.PNG)
Click on it and the request for your access will be sent over.
Click on it and the request for your access will be sent over.
![AR submit](/assets/AR_submitted.PNG)
# Setting up SSH access (optional)
In order to enable SSH access to git lab, an SSH key pair needs to be used. Learn how to create one [here](https://gitlab.openconn.org/help/ssh/README#generating-a-new-ssh-key-pair) or learn how to use an already existing ssh key [here](https://gitlab.openconn.org/help/ssh/README#locating-an-existing-ssh-key-pair).
Once you obtain an SSH key pair, learn how to add it to your Gitlab account [here](https://gitlab.openconn.org/help/ssh/README#adding-an-ssh-key-to-your-gitlab-account).
Once the ssh key has been added, it is advised to test the setup. Learn how to test the added ssh key [here](https://gitlab.openconn.org/help/ssh/README#testing-that-everything-is-set-up-correctly).
Once the ssh key has been added, it is advised to test the setup. Learn how to test the added ssh key [here](https://gitlab.openconn.org/help/ssh/README#testing-that-everything-is-set-up-correctly).
# Working with Gitlab
## Cloning a repository
The projects are orgnized in groups. To find a project, log in to your Gitlab account and select the "Projects" tab in the upper left corner then select "Explore projects" from the dropdown menu
......@@ -22,10 +34,10 @@ The projects are orgnized in groups. To find a project, log in to your Gitlab ac
The trending project will be listed by default. To list all projects, select the "All" sub-tab as shown in the screen shot below and you should be able to see all the projects you have at least read permissions.
![all projects](/assets/2.png)
Select the project and the project details page will open up. In the upper right corner, there is the "clone" blue button. Clicking it will give you the available options for cloning the projects; via ssh or https. If you have not already setup your ssh key then use the https link instead.
![clone button](/assets/3.png)
Copy the clone path and type the following command
***
$ git clone (paste the clone path here)
......@@ -44,7 +56,7 @@ In order to submit a merge request to any project in Gitlab, do the following st
![checkout branch](/assets/checkoutNewBranch.PNG)
4. Click the "Create merge request" blue button in the upper right corner to create the merge request. This will take you to the New Merge Request page where you can complete the merge request.
4. Click the "Create merge request" blue button in the upper right corner to create the merge request. This will take you to the New Merge Request page where you can complete the merge request.
![MR Button](/assets/MRButton.PNG)
......@@ -64,10 +76,10 @@ This method is similiar to the Github workflow where you can fork a project into
## Completing merge requests
Once the merge request form opens up, fill it out with the proper title and description. If you are still working on the changes, assign it to yourself and include the "WIP:" prefix in the title. Doing so will mark the merge request as Work in Progress. Otherwise, assign it to the responsible maintainers if the changes are completely done. The source and target branches will be auto-selected but they could be changed as needed.
Once the merge request form opens up, fill it out with the proper title and description. If you are still working on the changes, assign it to yourself and include the "WIP:" prefix in the title. Doing so will mark the merge request as Work in Progress. Otherwise, assign it to the responsible maintainers if the changes are completely done. The source and target branches will be auto-selected but they could be changed as needed.
![MR Form](/assets/MRForm.PNG)
It is customary to squash all commits in your feature branch into one or a few logically organized commits and delete your feature branch once merged into the target branch. You can check these options now or later.
It is customary to squash all commits in your feature branch into one or a few logically organized commits and delete your feature branch once merged into the target branch. You can check these options now or later.
Once done filling out the merge request form, click on the "submit merge request" green button at the bottom.
![MR submit button](/assets/MRSubmitButton.PNG)
......@@ -83,7 +95,7 @@ Another method of creating a merge request is to choose the "Merge Requests" opt
![New Merge request page](/assets/merge_request_page.PNG)
From there, you can specify not only the source branch but also the source project. This way, if you had your own fork of the project, then you can select your fork and your branch in your fork. The same thing could be done on the target side. this would allow you for example to test out the newly publish code in your own fork within the scope of a merge request which would highlight any merge conflicts or CI issues and allows others to comment and discuss it if needed.
once you have selected the source and the target, click on the "Compare branches and continue" green button.
once you have selected the source and the target, click on the "Compare branches and continue" green button.
![MR_form_1](/assets/merge_request_form.PNG)
Now, fill out the MR form properly and click on the "Submit merge request" green button to create the merge request.
......@@ -103,8 +115,8 @@ Once the issue is created, your teammate with the proper permissions will be abl
### Orgnize Issues
Issues can be organized into boards of a project and each board can have multiple lists of issues. Each board could be specific to a milestone or to a specific team and the lists within these boards could be a done pile for example or a backlog pile or Work-In_Progress (WIP) pile.
## Continuous Integration
Continuous Integration is one of the main advantages of Gitlab! In fact, it was rated as the best by the [Forrester CI Wave ™](https://about.gitlab.com/resources/forrester-wave-cloudnative-ci/) report.
To see the pipelines and the jobs of a project, click on the CI/CD option from the project menu then click on pipelines.You should be able to see all the historical pipelines.
Continuous Integration is one of the main advantages of Gitlab! In fact, it was rated as the best by the [Forrester CI Wave ™](https://about.gitlab.com/resources/forrester-wave-cloudnative-ci/) report.
To see the pipelines and the jobs of a project, click on the CI/CD option from the project menu then click on pipelines.You should be able to see all the historical pipelines.
![pipelines](/assets/pipelines.PNG)
From there, you can click on the jobs themselves and see the logs and the console.
![Job consol](/assets/job_consol.PNG)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment