Introduction

The purpose of this guide is to provide an introduction to using the GitLab^® platform and the AsciiDoc^® markup language that will enable you to collaborate with members of The Open Group to create content on The Open Group Digital Platform. The Open Group Digital Platform supports creation of content in multiple output formats from a single source. The supported output formats include html, pdf, ePUB, and Antora module output. The toolchain handles the details of the slight differences in source format.

Screenshots

This guide includes screenshots of many tasks and operations in the GitLab environment. It should be noted that since the GitLab environment has regular updates the interface may vary from that shown, however the guiding principles and outline approaches should still hold.

About this Guide

This guide is for individuals who are participating in Forums or Work Groups within The Open Group. It includes guidance on the development of The Open Group publications using the AsciiDoc markup language in a GitLab^® environment.

The high-level structure of this guide is as follows:

Introduction (this page) describes the purpose of this document, the contents of the guide, and how to use it
Introducing the GitLab Platform provides a first introduction to the GitLab platform, what it is, and why we are using it
Getting Started describes some of the basics to get you started working with the GitLab platform
Connecting to The Open Group GitLab site describes how to connect to The Open Group GitLab site
Working in the Browser describes how to work with the GitLab platform in a browser
Enabling Local Working is aimed at the advanced user, and describes how to get set up to enable local working
Using an Editor introduces the Brackets editor, an editor for local working
Using the AsciiDoc Markup Language provides a tutorial on the AsciiDoc markup language
Collaborative Working provides advice on ways of working in collaborative projects
The Open Group Standard Template describes how to instantiate a project using The Open Group Standard template
Using the GitLab Platform for a Company Review is for advanced users and describes a way of working using the GitLab platform for issue resolution in The Open Group Company Review process

How to Use this Guide

It is recommended that as you read this guide you try out some of the examples shown.

Playground Projects

There are two playground projects set up to allow you to try out the GitLab environment:

Cats and Dogs: a free-form project developing lists of cats and dogs
The Cats and Dogs Standard: a project using The Open Group Standard Template

To be added to these projects, please contact Andrew Josey.