2. Introducing the GitLab Platform
This chapter introduces the GitLab platform, and why it is used at The Open Group.
2.1. What is the GitLab Platform?
In technical terms, the GitLab platform is:
-
A web-based Git-repository manager with wiki and issue-tracking features, using an open-source license, developed by GitLab, Inc.
-
A single application for the entire software development lifecycle, from project planning and source code management to Continuous Integration (CI)/Continuous Development (CD), monitoring, and security
What does this mean in simple terms?
It is a hosting platform for version control and collaboration. It allows you and others to work together on projects from anywhere. Examples of projects range from developing standards, guides, and white papers to maintaining repositories of models, files, source code, etc.
2.2. Why Use the GitLab Platform at The Open Group?
The advantage of using the GitLab platform for collaborative development is that it provides a platform where everyone can contribute (with the minimum cost to entry being the use of a web browser). This approach allows us to change creative work from being mainly a read-only task to read-write. When everyone can contribute, consumers become contributors and we greatly increase the rate of progress.
What are the pros and cons?
Pros: It is possible to participate in document development without having to install any software; you can contribute using a web browser, and document builds are done automatically on the server. It has integrated task management and work flow.
Cons: It is something new with an associated learning curve; it looks technical.
2.3. How to Contribute
2.3.1. Viewing Content
There are two ways to view content in the GitLab platform:
-
If you are accessing using a web browser, visit the GitLab website and view the content there. This is particularly helpful if you are trying to catch up on changes, as the website will show you a list of recent changes (by viewing the “Commits”), let you browse the project sources, and review the progress of any issues in the “Issues” tracker.
-
If you are an advanced user and have connected to your project via a Git client, and created a local copy, simply navigate to that copy on your local machine and view it there. It is good practice to always “Fetch” and “Pull” a fresh copy before viewing, particularly if you intend to make any changes.
2.3.2. Submitting and Resolving Issues
The GitLab platform includes powerful issues tracking facility that allows project members to submit issues, assign people to address the issues, and track the progress of resolution. This is all managed through a web browser. Detailed instructions for how to use the Issues tracker are here.
2.3.3. Creating Content
Assuming you have set up your account and completed the steps in Chapter 4, you can either create content via the web browser (see Chapter 5), or if you are an advanced user start editing files in your local repository using an appropriate editor (see Chapter 6 and Chapter 7).
You will need some basic understanding of the AsciiDoc markup language. A tutorial is provided in Chapter 8 covering the key style elements used in The Open Group documents.
2.3.4. Collaborating in a Project
As most documents are developed collaboratively you will need to consider how to work within such a project. See Chapter 9 for some guidelines and considerations for collaborative working.