Skip to content

Commit dc306a5

Browse files
ereadRavlen
eread
authored and
Ravlen
committed
Rename index.md to _index.md for compatibility with docs-gitlab-com
Also moves all H1 headers into frontmatter
1 parent 0bf68e1 commit dc306a5

File tree

76 files changed

+176
-199
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+176
-199
lines changed

Diff for: ‎doc/.vale/gitlab_docs/FrontMatter.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
extends: script
2+
message: "Front matter must have valid 'title' and be closed."
3+
link: https://docs.gitlab.com/ee/development/documentation/metadata/
4+
level: error
5+
scope: raw
6+
script: |
7+
text := import("text")
8+
matches := []
9+
10+
// Initialize variables
11+
frontmatterDelimiterCount := 0
12+
frontmatter := ""
13+
hasError := false
14+
15+
// Check if frontmatter exists
16+
if !text.re_match("^---\n", scope) {
17+
hasError = true
18+
}
19+
20+
if !hasError {
21+
for line in text.split(scope, "\n") {
22+
if frontmatterDelimiterCount == 1 {
23+
frontmatter += line + "\n"
24+
}
25+
if frontmatterDelimiterCount == 2 {
26+
break
27+
}
28+
if text.re_match("^---", line) {
29+
frontmatterDelimiterCount++
30+
start := text.index(scope, line)
31+
matches = append(matches, {begin: start, end: start + len(line)})
32+
}
33+
}
34+
35+
// Check for unclosed frontmatter
36+
if frontmatterDelimiterCount != 2 {
37+
hasError = true
38+
}
39+
40+
// First check if we have a title key at all
41+
hasTitleKey := text.re_match("(?m)^[tT]itle:", frontmatter)
42+
// Then check if it has content (anything but whitespace) after the colon
43+
hasValidTitle := text.re_match("(?m)^[tT]itle:[^\\n]*[^\\s][^\\n]*$", frontmatter)
44+
45+
if !hasError && (!hasTitleKey || !hasValidTitle) {
46+
hasError = true
47+
}
48+
}
49+
50+
if !hasError {
51+
matches = []
52+
}

Diff for: ‎doc/index.md renamed to ‎doc/_index.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Linux package documentation
56
---
67

7-
# Linux package documentation
8-
98
DETAILS:
109
**Tier:** Free, Premium, Ultimate
1110
**Offering:** GitLab Self-Managed
@@ -25,7 +24,7 @@ configuration.
2524

2625
## Installation
2726

28-
For installation details, see [Install GitLab with the Linux package](installation/index.md).
27+
For installation details, see [Install GitLab with the Linux package](installation/_index.md).
2928

3029
## Running on a low-resource device (like a Raspberry Pi)
3130

@@ -34,12 +33,12 @@ to work best with the available resources. Check out the [documentation](setting
3433

3534
## Maintenance
3635

37-
- [Get service status](maintenance/index.md#get-service-status)
38-
- [Starting and stopping](maintenance/index.md#starting-and-stopping)
39-
- [Invoking Rake tasks](maintenance/index.md#invoking-rake-tasks)
40-
- [Starting a Rails console session](maintenance/index.md#starting-a-rails-console-session)
41-
- [Starting a PostgreSQL superuser `psql` session](maintenance/index.md#starting-a-postgresql-superuser-psql-session)
42-
- [Container registry garbage collection](maintenance/index.md#container-registry-garbage-collection)
36+
- [Get service status](maintenance/_index.md#get-service-status)
37+
- [Starting and stopping](maintenance/_index.md#starting-and-stopping)
38+
- [Invoking Rake tasks](maintenance/_index.md#invoking-rake-tasks)
39+
- [Starting a Rails console session](maintenance/_index.md#starting-a-rails-console-session)
40+
- [Starting a PostgreSQL superuser `psql` session](maintenance/_index.md#starting-a-postgresql-superuser-psql-session)
41+
- [Container registry garbage collection](maintenance/_index.md#container-registry-garbage-collection)
4342

4443
## Configuring
4544

@@ -65,7 +64,7 @@ to work best with the available resources. Check out the [documentation](setting
6564
- [`gitlab.yml`](settings/gitlab.yml.md)
6665
- [Backups](settings/backups.md)
6766
- [Pages](https://docs.gitlab.com/ee/administration/pages/index.html)
68-
- [SSL](settings/ssl/index.md)
67+
- [SSL](settings/ssl/_index.md)
6968
- [GitLab and Registry](https://docs.gitlab.com/ee/administration/packages/container_registry.html)
7069
- [Configuring an asset proxy server](https://docs.gitlab.com/ee/security/asset_proxy.html)
7170
- [Image scaling](settings/image_scaling.md)
@@ -90,4 +89,4 @@ For troubleshooting details, see [Troubleshooting Omnibus GitLab installation is
9089

9190
## Omnibus GitLab developer documentation
9291

93-
See the [development documentation](development/index.md)
92+
See the [development documentation](development/_index.md)

Diff for: ‎doc/architecture/index.md renamed to ‎doc/architecture/_index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Omnibus GitLab architecture and components
56
---
67

7-
# Omnibus GitLab architecture and components
8-
98
Omnibus GitLab is a customized fork of the Omnibus project from Chef, and it
109
uses Chef components like cookbooks and recipes to perform the task of
1110
configuring GitLab on a user's computer. [Omnibus GitLab repository on GitLab.com](https://gitlab.com/gitlab-org/omnibus-gitlab)
@@ -258,7 +257,7 @@ Omnibus GitLab database. Over time, this has changed:
258257

259258
Because additional databases might be necessary:
260259

261-
- The [multi-database blueprint](multiple_database_support/index.md) explains
260+
- The [multi-database blueprint](multiple_database_support/_index.md) explains
262261
how to add database support to Omnibus GitLab for new components and features.
263262
- The [accompanying development document](../development/database_support.md)
264263
details the implementation model and provides examples of adding database

Diff for: ‎doc/architecture/multiple_database_support/index.md renamed to ‎doc/architecture/multiple_database_support/_index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,16 @@ authors: [ "@pursultani" ]
55
approvers: [ "@product-manager", "@engineering-manager" ]
66
owning-stage: "~devops::systems"
77
participating-stages: []
8+
title: Multiple databases support
89
---
910

10-
# Multiple databases support
11-
1211
## Summary
1312

1413
This document explains how to support a component with one or more databases. It
1514
describes different levels of support and offers an implementation model for
1615
each level to overcome the several challenges of the [recommended deployment models](https://docs.gitlab.com/ee/administration/reference_architectures/).
1716

18-
The [architecture page](../index.md#multiple-databases) provides some
17+
The [architecture page](../_index.md#multiple-databases) provides some
1918
background on this subject.
2019

2120
A [development document](../../development/database_support.md) accompanies this

Diff for: ‎doc/build/index.md renamed to ‎doc/build/_index.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Building `omnibus-gitlab` packages and Docker images locally
56
---
67

7-
# Building `omnibus-gitlab` packages and Docker images locally
8-
98
NOTE:
109
If you are a GitLab team member, you have access to our CI infrastructure which
1110
can be used to build these artifacts. Check the [documentation](team_member_docs.md)

Diff for: ‎doc/build/build_docker_image.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Build a GitLab Docker image locally
56
---
67

7-
# Build a GitLab Docker image locally
8-
98
The GitLab Docker image uses the Ubuntu 22.04 package created by
109
`omnibus-gitlab`. Most of the files needed for building a Docker image
1110
are in the `Docker` directory of the `omnibus-gitlab` repository.

Diff for: ‎doc/build/build_package.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Build an `omnibus-gitlab` package locally
56
---
67

7-
# Build an `omnibus-gitlab` package locally
8-
98
## Prepare a build environment
109

1110
Docker images with the necessary build tools for building `omnibus-gitlab` packages

Diff for: ‎doc/build/team_member_docs.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: GitLab Team member's guide to using official build infrastructure
56
---
67

7-
# GitLab Team member's guide to using official build infrastructure
8-
98
If you are a GitLab team member, you have access to the build
109
infrastructure or to the colleagues who have access to the infrastructure. You
1110
can use that access to build packages.

Diff for: ‎doc/development/index.md renamed to ‎doc/development/_index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Contribute to Omnibus GitLab development
56
---
67

7-
# Contribute to Omnibus GitLab development
8-
98
## Getting started
109

11-
1. [Understanding the Omnibus GitLab Architecture](../architecture/index.md)
10+
1. [Understanding the Omnibus GitLab Architecture](../architecture/_index.md)
1211
1. [Setting up a local development environment](setup.md)
1312

1413
## How everyone can contribute to Omnibus GitLab
@@ -23,7 +22,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
2322

2423
- [CI variables](ci-variables.md)
2524
- [Repositories, branches and CI pipelines](pipelines.md)
26-
- [Release process](../release/index.md)
25+
- [Release process](../release/_index.md)
2726
- [Version format of packages, Docker images and other artifacts](package_version_format.md)
2827
- [Handling broken master pipelines](broken_master.md)
2928
- [Handling vulnerabilities](vulnerabilities.md)

Diff for: ‎doc/development/add-remove-configuration-options.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Add or remove Omnibus GitLab configuration options
56
---
67

7-
# Add or remove Omnibus GitLab configuration options
8-
98
## Add a configuration option
109

1110
Adding a configuration option may happen during any release milestone.

Diff for: ‎doc/development/adding-deprecation-messages.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Omnibus GitLab deprecation process
56
---
67

7-
# Omnibus GitLab deprecation process
8-
98
Besides following the [GitLab deprecation guidelines](https://handbook.gitlab.com/handbook/product/gitlab-the-product/#deprecations-removals-and-breaking-changes), we should also add deprecation messages
109
to the Omnibus GitLab package.
1110

Diff for: ‎doc/development/allure-test-report.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Test Report Generation in Omnibus-GitLab
56
---
67

7-
# Test Report Generation in Omnibus-GitLab
8-
98
The following three pipelines are created while generating the allure-report
109

1110
- Omnibus pipeline

Diff for: ‎doc/development/aws_amis_and_marketplace_listings.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Amazon Machine Images (AMIs) and Marketplace Listings
56
---
67

7-
# Amazon Machine Images (AMIs) and Marketplace Listings
8-
98
GitLab caters to the AWS ecosystem via the following methods
109

1110
1. Community AMIs

Diff for: ‎doc/development/broken_master.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Handling broken master pipelines
56
---
67

7-
# Handling broken master pipelines
8-
98
We currently run [nightly pipelines](pipelines.md#scheduled-pipelines) for
109
building both CE and EE package in our Release mirror: `https://dev.gitlab.org/gitlab/omnibus-gitlab`.
1110
This mirror is configured to send pipeline failure notifications to

Diff for: ‎doc/development/change-package-behavior.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Add or change behavior during package install and upgrade
56
---
67

7-
# Add or change behavior during package install and upgrade
8-
98
## Test changes during install/upgrade
109

1110
If you are working on changes to the install/upgrade process, and not the reconfigure process itself, you can use the [scripts/repack-deb](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/scripts/repack-deb) tool to quickly repack an existing GitLab deb with changes from your local branch. It will repack the existing deb file into a new deb containing the local content from

Diff for: ‎doc/development/ci-variables.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: CI Variables
56
---
67

7-
# CI Variables
8-
98
`omnibus-gitlab` [CI pipelines](pipelines.md) use variables provided by the CI environment to change build behavior between mirrors and
109
keep sensitive data out of the repositories.
1110

Diff for: ‎doc/development/contribute-to-omnibus-gitlab.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Contribute to Omnibus GitLab
56
---
67

7-
# Contribute to Omnibus GitLab
8-
98
## Common enhancement tasks
109

1110
- [Adding and removing configuration options](add-remove-configuration-options.md)
@@ -25,7 +24,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
2524

2625
## Build and test your enhancement
2726

28-
- [Building your own package](../build/index.md)
27+
- [Building your own package](../build/_index.md)
2928
- [Building a package from a custom branch](../build/team_member_docs.md#test-an-omnibus-gitlab-project-mr)
3029

3130
## Submit your enhancement for review

Diff for: ‎doc/development/creating-patches.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Create Patches
56
---
67

7-
# Create Patches
8-
98
You can manually modify an external dependency to:
109

1110
- Make sure that dependency works with Omnibus embedded packaging.

Diff for: ‎doc/development/database_support.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Database support
56
---
67

7-
# Database support
8-
98
This document provides details and examples on how to implement database support
10-
for an Omnibus GitLab component. The [architecture blueprint](../architecture/multiple_database_support/index.md)
9+
for an Omnibus GitLab component. The [architecture blueprint](../architecture/multiple_database_support/_index.md)
1110
provides the design and definitions.
1211

1312
1. [Level 1](#level-1)

Diff for: ‎doc/development/deprecating-and-removing-support-for-an-os.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Deprecate and remove support for a supported operating system
56
---
67

7-
# Deprecate and remove support for a supported operating system
8-
98
GitLab provides Omnibus packages for operating systems (OS) only until their end of life (EOL).
109
After the EOL date of the OS, GitLab stops releasing official
1110
packages. The following content documents how to:

Diff for: ‎doc/development/gitlab-ctl-commands.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Adding new `gitlab-ctl` commands
56
---
67

7-
# Adding new `gitlab-ctl` commands
8-
98
New `gitlab-ctl` commands can be added to two directory : `files/gitlab-ctl-commands` and `files/gitlab-ctl-commands-ee`. Chef stores `gitlab-ctl` commands in `/opt/gitlab/embedded/service/omnibus-ctl`.
109

1110
There are two main functions you will use to add commands (<https://github.com/chef/omnibus-ctl>):

Diff for: ‎doc/development/maintainership.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
5+
title: Maintainership
56
---
67

7-
# Maintainership
8-
98
## Scoped Maintainership
109

1110
`omnibus-gitlab` is a comparatively complex project that handles both software

0 commit comments

Comments
 (0)