Docs: CI/CD guides for beginners
Type of issue
Plan for documentation improvement: beginners guides for CI/CD.
Problem to solve
Onboarding GitLab CI/CD is hard. The goal is to make the CI/CD beginners guides to be clear and well structured to make the 1st time user easily get started.
Further details
Part of the work for:
Proposal
- Write a high-level introduction to the concepts of CI/CD/CD and to GitLab CI/CD => https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/25611
- New "hello world" guide, explaining how to deploy a simple application with CI/CD (prob Ruby on Rails):
- We already have this guide for GitLab Pages users who wish to write their own script for a non-existing Pages example. The idea is to use what we already have until we have a second example of a non-Pages app. To do so, we need to add to this doc's intro that:
-
This is not necessary to get started with Pages (we have project templates, .gitlab-ci.yml
templates, and the Pages group with example projects to onboard the newcomer to GL Pages. -
Explain that this guide is an intro to CI/CD since it teaches the users to create their own CI/CD config by adding their scripts into the file.
-
- In a follow-up iteration, write the new "hello world" guide at the light of the Pages step-by-step guide and link both from the higher-level indexes. => https://gitlab.com/gitlab-org/gitlab-ce/issues/58352
- We already have this guide for GitLab Pages users who wish to write their own script for a non-existing Pages example. The idea is to use what we already have until we have a second example of a non-Pages app. To do so, we need to add to this doc's intro that:
- Write new docs as CI/CD workflow examples, to be linked from the new introductory guide, main CI/CD index, and CI/CD examples. => https://gitlab.com/gitlab-org/gitlab-ce/issues/58042
Who can address the issue
@gl-docsteam with help from the PMs and devs.
Other links/references
- Follow up from https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/25611
Edited by Marcia Ramos