Merge branch 'read-me-update' into 'main'

## Getting started

## Scope

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

The intention of the plan is to try out CR handling. Namely preparing a CR, receiving comments, update the CR based on those comments and approve/reject/postpone a CR. The figure below depicts the main steps in way of working that can be different with Gitlab.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!

![](./figures/current_git_Wow.png)

## Add your files

## The trial

Interested delegates can login to the 3GPP forge and enter the repository to start playing around with the environment. We think the trial can be open in the sense that delegates can play around without restrictions, however there are a few things which we would highlight hereafter to take into account during the trial. Other options are available and thus this document does not limit what one can do but can give some direction for those new into the tools involved in this trial. For those that would want to get familiar with the git commands and how to perform the steps below via such commands, one can refer to the [Gitlab documentation](https://docs.gitlab.com/user/get_started/). 

- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files

- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:

## Provide comments to CRs

On the left side menu, you can click on the option “Merge requests” (or one can directly go to the [link for merge requests](https://forge.3gpp.org/rep/bergstromm/ran2_trial/-/merge_requests)). A list of all available CRs (here called “merge requests”) should appear.  

Click in one of the CRs, which should depict the CR overview as below.

```

cd existing_repo

git remote add origin https://forge.3gpp.org/rep/bergstromm/ran2_trial.git

git branch -M main

git push -uf origin main

```

![](./figures/merge_request.png)

## Integrate with your tools

In the “Overview” tab one can see the usual coversheet elements of the CR. In the “Changes” tab one can check all the changes proposed by the CR. When checking the changes, the left side shows the line number of each text. If one mouse-over one of the lines, a comment icon should appear (as depicted below), which when clicked should open a dialog box for comments. Alternatively, one can also click at the right top comment icon, to make a comment to the overall CR instead of a particular line. 

- [ ] [Set up project integrations](https://forge.3gpp.org/rep/bergstromm/ran2_trial/-/settings/integrations)

![](./figures/comments.png)

## Collaborate with your team

Once the comment is done one can click on “Add comment now” to insert the comment.

## Create CRs

On the trial repository, in the top right, select the vertical ellipsis and select “Request Access”.

- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)

- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)

- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)

- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)

- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

![](./figures/request_access.png)

## Test and Deploy

Note this step is essential for all others below, and you would have to wait for someone to approve your request before following the remaining steps.

Use the built-in continuous integration in GitLab.

On the trial repository in the top right, select “Edit” and then “Open in Web IDE”. The editor view will open. On the left side menu, one can navigate through the files in the trial and modify multiple ones. These modifications will be marked in the left side bar with branch icon (called “source control”). For instance, in the depicted example below two modifications were done (one in Connection Setup.mb and one in System Information.md) and those are marked by the number two on the branch icon. 

- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)

- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)

- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)

- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)

- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

![](./figures/edit_view.png)

***

When all the modifications are done, one can click on the branch icon and see all the changes performed. Under “Commit message” write a one sentence summary of your CR. Then on the right of “Commit and push to ‘main’”, one can click on the down arrow icon and an option should appear to “Commit to new branch”. Once that option is clicked you should write the name of the new branch i.e. a CR tittle (note that there should be no spaces between words names, - can be used instead e.g. this-is-the-CR-tittle).

# Editing this README

![](./figures/commit_view.png)

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.

After this step, on the right bottom of the screen it should appear an option to create a merge request “Create MR”. When clicked, this will lead to the merge request view where you can fill in details similar as done in [the first CR](https://forge.3gpp.org/rep/bergstromm/ran2_trial/-/merge_requests/3) (merge request) we provided as example (e.g. the “Description” field and “Labels” could be filled in). 

Once done filling in the merge request details, click on “Create merge request” at bottom left.

## Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

## Approve/Reject CRs

On the left side menu, you can click on the option “Merge requests” (or one can directly go to the [link for merge requests](https://forge.3gpp.org/rep/bergstromm/ran2_trial/-/merge_requests)). A list of all available CRs (here called “merge requests”) should appear.  

Click in one of the CRs, which should depict the CR overview as below.

## Name

Choose a self-explaining name for your project.

![](./figures/merge_request.png)

## Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

## Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

## Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

## Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

## Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

## Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

## Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

## Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

## License

For open source projects, say how it is licensed.

## Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

On the right side menu, note the “Labels” option can be edited. If “Edit” in “Labels” is clicked, the labels applicable to this merge request can be changed. One can look for the specific labels Agreed, Postponed or Rejected and add one of them to the merge request.

 No newline at end of file