Skip to content
Snippets Groups Projects
Commit 9768dfdc authored by Evan Read's avatar Evan Read Committed by Marcel Amirault
Browse files

Rename index.md to _index.md for compatibility with docs-gitlab-com

As part of update to new docs site engine, use _index.md and
put titles in metadata.
parent 9d237568
No related branches found
No related tags found
1 merge request!1066Rename index and move titles to frontmatter
Showing
with 72 additions and 39 deletions
extends: script
message: "Front matter must have valid 'title' and be closed."
link: https://docs.gitlab.com/ee/development/documentation/metadata/
level: error
scope: raw
script: |
text := import("text")
matches := []
// Initialize variables
frontmatterDelimiterCount := 0
frontmatter := ""
hasError := false
// Check if frontmatter exists
if !text.re_match("^---\n", scope) {
hasError = true
}
if !hasError {
for line in text.split(scope, "\n") {
if frontmatterDelimiterCount == 1 {
frontmatter += line + "\n"
}
if frontmatterDelimiterCount == 2 {
break
}
if text.re_match("^---", line) {
frontmatterDelimiterCount++
start := text.index(scope, line)
matches = append(matches, {begin: start, end: start + len(line)})
}
}
// Check for unclosed frontmatter
if frontmatterDelimiterCount != 2 {
hasError = true
}
// First check if we have a title key at all
hasTitleKey := text.re_match("(?m)^[tT]itle:", frontmatter)
// Then check if it has content (anything but whitespace) after the colon
hasValidTitle := text.re_match("(?m)^[tT]itle:[^\\n]*[^\\s][^\\n]*$", frontmatter)
if !hasError && (!hasTitleKey || !hasValidTitle) {
hasError = true
}
}
if !hasError {
matches = []
}
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: GitLab Operator
---
# GitLab Operator
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Backup and Restore GitLab
---
# Backup and Restore GitLab
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: RedHat-certified images
---
# RedHat-certified images
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Dependency on GitLab Charts
---
# Dependency on GitLab Charts
The GitLab Operator (also just known as "Operator") depends on the [GitLab Helm Charts](https://gitlab.com/gitlab-org/charts/gitlab) (also just known as "Chart").
as described in
[ADR 0004](https://gitlab.com/gitlab-org/cloud-native/gitlab-operator/-/blob/master/doc/adr/0004-integration-of-the-gitlab-chart.md).
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: CI
---
# CI
## Review environments
The review environments are automatically uninstalled after 1 hour. If you need the review environment to stay up longer, you can pin the environment
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Developer Guide
---
# Developer Guide
This developer guide aims to walk a new developer on how to set up their environment to be able to contribute to this project.
## Setting up development environment
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Installation
---
# Installation
This document describes how to deploy the GitLab Operator via manifests in your Kubernetes or OpenShift cluster.
If using OpenShift, these steps are usually handled by OLM (the Operator Lifecycle Manager) once an operator is bundle published. However, to test the most recent operator images, users may need to install the operator using the deployment manifests available in the operator repository.
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: OpenShift Cluster Setup
---
# OpenShift Cluster Setup
This document walks you through using the automation scripts in this project to create an OpenShift cluster in Google Cloud.
## Preparation
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: How to publish to OperatorHub.io
---
# How to publish to OperatorHub.io
OperatorHub.io is a home for the Kubernetes community to share Operators.
NOTE:
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: GitLab autodeployment for testing
---
# GitLab autodeployment for testing
## Requirements
- `openssl` utility
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: RedHat Operator Bundle certification process
---
# RedHat Operator Bundle certification process
This document outlines certification process for OLM bundle submission for RedHat Marketplace. It is based on
[Red Hat Software Certification Workflow Guide](https://docs.redhat.com/en/documentation/red_hat_software_certification/2024/html/red_hat_software_certification_workflow_guide/assembly-running-the-certification-suite-locally_openshift-sw-cert-workflow-working-with-operators).
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: RedHat Operator Bundle certification process
---
# RedHat Operator Bundle certification process
This document outlines certification process for OLM bundle submission for RedHat Marketplace. It is based on
[Red Hat Software Certification Workflow Guide](https://docs.redhat.com/en/documentation/red_hat_software_certification/2024/html/red_hat_software_certification_workflow_guide/assembly-running-the-certification-suite-locally_openshift-sw-cert-workflow-working-with-operators).
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Versioning
---
# Versioning
The GitLab Operator uses [semver versioning](https://semver.org/). Version tags should
[be the semver version string](https://gitlab.com/gitlab-org/cloud-native/gitlab-operator/-/blob/master/doc/adr/0009-version-tagging.md).
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Test OLM Bundles
---
# Test OLM Bundles
## Pre-requisites
Versions listed are the ones known to work, lower versions may work but were not tested
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Configure the GitLab Operator with GitLab Geo
---
# Configure the GitLab Operator with GitLab Geo
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Support for Git over SSH
---
# Support for Git over SSH
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Upgrading GitLab
---
# Upgrading GitLab
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
......
......@@ -2,16 +2,15 @@
stage: Systems
group: Distribution
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
title: Installation
---
# Installation
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
NOTE:
The GitLab Operator has [known limitations](index.md#known-issues) and is only suitable for specific scenarios in production use.
The GitLab Operator has [known limitations](_index.md#known-issues) and is only suitable for specific scenarios in production use.
<!--This warning block is duplicated in doc/index.md. Changes should be reflected in both locations.-->
WARNING:
......
......@@ -2,10 +2,9 @@
stage: Systems
group: Distribution
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
title: Ingress in OpenShift
---
# Ingress in OpenShift
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab Self-Managed
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment