CI/CD doc structure plan

Type of issue

Improving an existing doc; e.g. adding a diagram, adding or rewording text, resolving redundancies, cross-linking, etc.

Problem to solve

Improve the structure of CI/CD documentation.

Further details

For:

  • &784 (closed)
  • https://gitlab.com/gitlab-org/gitlab-ce/issues/58394

Proposal

UPDATE:

  • Add an introduction to GitLab CI/CD and reorg ci/README.md into a smoother reading flow. => https://gitlab.com/gitlab-org/gitlab-ce/issues/58323 // https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/27620
  • Add an illustration to ci/REAME.md#overview. => https://gitlab.com/gitlab-org/gitlab-ce/issues/59110

Last proposal's draft.

CI Index Page

UPDATE:

  • Overview (links to introduction)
  • Getting started
  • Configuration
  • Feature set
  • Feature set (advanced)
  • Examples
  • Admin (CORE ONLY)
  • References

Done by: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/27620

Content pages

  • Index page (who updates it; which concepts go there at what level)
  • Concepts of CI/CD (Pipelines, Job, Runner, etc.) (including example workflow)
    • Page: Example workflows/configs for dev teams using CI/CD
  • Basic how-to/walkthrough - hello world - like Pages
  • Configuration
    • Yaml page

Who can address the issue

@gl-docsteam

Edited Apr 26, 2019 by Marcia Ramos
Assignee Loading
Time tracking Loading