Update content to use Hugo shortcodes

Author: Sarah German

doc/_index.md

@@ -5,9 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: Linux package documentation
 ---
 
-DETAILS:
-**Tier:** Free, Premium, Ultimate
-**Offering:** GitLab Self-Managed
+{{< details >}}
+
+- Tier: Free, Premium, Ultimate
+- Offering: GitLab Self-Managed
+
+{{< /details >}}
 
 The Linux package has different services and tools required to run GitLab. Most users can install it without laborious
 configuration.

doc/architecture/multiple_database_support/_index.md

@@ -1,10 +1,4 @@
 ---
-status: proposed
-creation-date: "2023-10-02"
-authors: [ "@pursultani" ]
-approvers: [ "@product-manager", "@engineering-manager" ]
-owning-stage: "~devops::systems"
-participating-stages: []
 title: Multiple databases support
 ---
 

doc/build/_index.md

@@ -5,11 +5,14 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: Building `omnibus-gitlab` packages and Docker images locally
 ---
 
-NOTE:
+{{< alert type="note" >}}
+
 If you are a GitLab team member, you have access to our CI infrastructure which
 can be used to build these artifacts. Check the [documentation](team_member_docs.md)
 for more details.
 
+{{< /alert >}}
+
 ## `omnibus-gitlab` packages
 
 `omnibus-gitlab` uses [Omnibus](https://github.com/chef/omnibus) for
@@ -22,11 +25,14 @@ How to build a custom package locally is described in the
 
 ## All-in-one Docker image
 
-NOTE:
+{{< alert type="note" >}}
+
 If you want individual Docker images for each GitLab component instead of the
 all-in-one monolithic one, check out the
 [CNG](https://gitlab.com/gitlab-org/build/CNG) repository.
 
+{{< /alert >}}
+
 The GitLab all-in-one Docker image uses the `omnibus-gitlab` package built for
 Ubuntu 22.04 under the hood. The Dockerfile is optimized to be used in a CI
 environment, with the expectation of packages being available over the Internet.

doc/build/team_member_docs.md

@@ -54,9 +54,12 @@ environment variable is set to the commit SHA corresponding to the pipeline.
 Other environment variables, if not specified, are populated from
 their corresponding files and passed on to the triggered pipeline.
 
-NOTE:
+{{< alert type="note" >}}
+
 Environment variables take precedence over `*_VERSION` files.
 
+{{< /alert >}}
+
 ### Temporarily specify a component version
 
 Temporarily specify a component version using any of the following methods:

doc/development/contribute-to-omnibus-gitlab.md

@@ -51,9 +51,12 @@ their applicability:
 1. If merge request introduces change in user facing configuration, update to [`gitlab.rb.template`](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template)
 1. [Changelog entry](https://docs.gitlab.com/ee/development/changelog.html) to inform about the change, if necessary.
 
-NOTE:
+{{< alert type="note" >}}
+
 Ensure shared runners are enabled for your fork in order for our automated tests to run:
 
+{{< /alert >}}
+
 1. Go to **Settings -> CI/CD**.
 1. Expand Runners settings.
 1. If shared runners are not enabled, click on the button labeled **Enable shared Runners**.

doc/development/maintainership.md

@@ -39,13 +39,16 @@ get infrequent updates, therefore it is not fair to expect trainee-maintainers
 to work on all of them. The following checklist provides a guideline to evaluate
 the progress of a trainee-maintainer in the build scope.
 
-NOTE:
+{{< alert type="note" >}}
+
 We do not differentiate between the trainee-maintainer as the author
 or reviewer in this list because `omnibus-gitlab` is a relatively stable
 and mature project. The majority of merge requests follow established
 patterns and only need to pass a set of well known tests that prove
 the changes work as expected.
 
+{{< /alert >}}
+
 1. Author or review merge requests which update any 3 components from the list below that
    support high availability. The trainee-maintainer should gain familiarity with complex
    deployment scenarios and how to test them.

doc/development/package_version_format.md

@@ -15,12 +15,15 @@ pipelines generally produce three types of packages:
 - nightly builds
 - tagged release builds
 
-NOTE:
+{{< alert type="note" >}}
+
 The `build_iteration` portion of versions strings conveys a specific meaning
 and contributes to how `build_version` is computed. The next sections are
 written with that in mind as `build_iteration` must be understood first even
 though it comes last in the version string.
 
+{{< /alert >}}
+
 ### Build Iteration
 
 Version strings use `build_iteration` when packaging related logic changes

doc/development/pipelines.md

@@ -18,10 +18,13 @@ between all the mirrors of the project:
 
 ### Protected branches
 
-NOTE:
+{{< alert type="note" >}}
+
 Unless specified otherwise, the listed users/groups have permission to both merge, and push to
 protected branches.
 
+{{< /alert >}}
+
 1. Development repository:
    1. `master`: Maintainers, [Delivery team](https://gitlab.com/gitlab-org/delivery)
    1. `*-stable` : [Delivery team](https://gitlab.com/gitlab-org/delivery), [Release Managers](https://gitlab.com/gitlab-org/release/managers)
@@ -43,18 +46,24 @@ protected branches.
 1. QA mirror:
    1. `master`: Developers (Merge only), Maintainers
 
-NOTE:
+{{< alert type="note" >}}
+
 Developers get access to `master` branch in QA mirror because
 that's required to run a triggered pipeline against the branch. There is an
 [open issue](https://gitlab.com/gitlab-org/gitlab/-/issues/24585) to change this
 situation.
 
+{{< /alert >}}
+
 ### Protected Tags
 
-NOTE:
+{{< alert type="note" >}}
+
 Unless specified otherwise, the listed users/groups have permission to both merge, and push to
 protected tags.
 
+{{< /alert >}}
+
 1. Development repository:
    1. `*` : Maintainers, [Delivery team](https://gitlab.com/gitlab-org/delivery), [Release Managers](https://gitlab.com/gitlab-org/release/managers)
 
@@ -345,29 +354,38 @@ to an S3 bucket in addition to making them available as artifacts.
 
 This job is run only on [Release mirror](https://dev.gitlab.org/gitlab/omnibus-gitlab) on tag pipelines.
 
-NOTE:
+{{< alert type="note" >}}
+
 Raspberry Pi jobs are run only on CE tags while SLES jobs are run only on EE tags.
 
+{{< /alert >}}
+
 ### `<OS_NAME>-staging`
 
 These jobs upload the packages built in previous job to an internal staging
 repository in [Packagecloud instance](https://packages.gitlab.com).
 
 This job is run only on [Release mirror](https://dev.gitlab.org/gitlab/omnibus-gitlab) on tag pipelines.
 
-NOTE:
+{{< alert type="note" >}}
+
 Raspberry Pi jobs are run only on CE tags while SLES jobs are run only on EE tags.
 
+{{< /alert >}}
+
 ### `<OS_NAME>-release`
 
 These jobs pulls the packages from the internal staging repository to a public
 repository in [Packagecloud instance](https://packages.gitlab.com).
 
 This job is run only on [Release mirror](https://dev.gitlab.org/gitlab/omnibus-gitlab) on tag pipelines.
 
-NOTE:
+{{< alert type="note" >}}
+
 Raspberry Pi jobs are run only on CE tags while SLES jobs are run only on EE tags.
 
+{{< /alert >}}
+
 ### `Docker`
 
 This job builds a GitLab Docker image using the package built during the Ubuntu

doc/development/setup.md

@@ -55,10 +55,13 @@ to use a container for development.
 1. Get the GitLab CE nightly package from the [Nightly Build repository](https://packages.gitlab.com/gitlab/nightly-builds)
    and install it using the instructions given on that page.
 
-   NOTE:
-   On Ubuntu Xenial, you may have to install `tzdata`. This
+   {{< alert type="note" >}}
+
+On Ubuntu Xenial, you may have to install `tzdata`. This
    [issue is reported in #4769](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/4679).
 
+   {{< /alert >}}
+
 1. Configure and start GitLab.
 1. Check if you can access the GitLab instance from your host browser on `<ip address of host>`.
 1. Install the basic tools used for developing Omnibus GitLab:
@@ -193,9 +196,12 @@ gitlab_rails['env'] = {
 }
 ```
 
-NOTE:
+{{< alert type="note" >}}
+
 For [GitLab Geo](https://docs.gitlab.com/ee/administration/geo/), deployments using the above configuration must be added to each secondary site.
 
+{{< /alert >}}
+
 ## OpenShift GitLab Development Setup
 
 See Omnibus GitLab [development setup](https://gitlab.com/gitlab-org/cloud-native/gitlab-operator/-/blob/master/doc/developer/guide.md) documentation.

doc/installation/_index.md

@@ -5,9 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: Install GitLab with the Linux package
 ---
 
-DETAILS:
-**Tier:** Free, Premium, Ultimate
-**Offering:** GitLab Self-Managed
+{{< details >}}
+
+- Tier: Free, Premium, Ultimate
+- Offering: GitLab Self-Managed
+
+{{< /details >}}
 
 ## Prerequisites
 
@@ -55,10 +58,13 @@ after 24 hours, this file is automatically removed by the first `gitlab-ctl reco
 The default account is tied to a randomly-generated email address. To override
 this, pass the `GITLAB_ROOT_EMAIL` environment variable to the installation command.
 
-NOTE:
+{{< alert type="note" >}}
+
 If GitLab can't detect a valid hostname for the server during the
 installation, a reconfigure does not run.
 
+{{< /alert >}}
+
 To provide a custom initial root password, you have two options:
 
 - Pass the `GITLAB_ROOT_PASSWORD` environment variable to the
@@ -104,11 +110,14 @@ database, configuration) or remove all of them:
    sudo gitlab-ctl stop && sudo gitlab-ctl remove-accounts
    ```
 
-   NOTE:
-   If you have problems removing accounts or groups, run `userdel` or `groupdel` manually
+   {{< alert type="note" >}}
+
+If you have problems removing accounts or groups, run `userdel` or `groupdel` manually
    to delete them. You might also want to manually remove the leftover user home directories
    from `/home/`.
 
+   {{< /alert >}}
+
 1. Choose whether to keep your data or remove all of them:
 
    - To preserve your data (repositories, database, configuration), stop GitLab and

doc/jihu_edition.md

@@ -5,9 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: JiHu Edition
 ---
 
-NOTE:
+{{< alert type="note" >}}
+
 This section is only relevant if you are a customer in the Chinese market.
 
+{{< /alert >}}
+
 GitLab licensed its technology to a new independent Chinese company, called JiHu.
 This independent company will help drive adoption of the GitLab complete DevOps
 platform in China and foster the GitLab community and open source contributions.
@@ -25,12 +28,15 @@ that you can use as part of the installation process.
 
 ## Install or update a JiHu Edition package
 
-NOTE:
+{{< alert type="note" >}}
+
 If you are installing for the first time, you have to pass the
 `EXTERNAL_URL="<GitLab URL>"` variable to set your preferred domain name. Installation
 automatically configures and starts GitLab at that URL. Enabling HTTPS requires
 [additional configuration](settings/nginx.md#enable-https) to specify the certificates.
 
+{{< /alert >}}
+
 Please refer to the [GitLab Jihu Edition Install](https://gitlab.cn/install/) page
 for more details on installing or updating a JiHu Edition package.
 

doc/maintenance/_index.md

@@ -5,9 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: Maintenance commands
 ---
 
-DETAILS:
-**Tier:** Free, Premium, Ultimate
-**Offering:** GitLab Self-Managed
+{{< details >}}
+
+- Tier: Free, Premium, Ultimate
+- Offering: GitLab Self-Managed
+
+{{< /details >}}
 
 The following commands can be run after installation.
 

doc/release/_index.md

@@ -114,9 +114,12 @@ the build type package will be pushed to <https://packages.gitlab.com> or to a t
    git tag -a 6.6.0+ce.0 -m 'Pin GitLab to v6.6.0'
    ```
 
-   WARNING:
+   {{< alert type="warning" >}}
+
    Do NOT use a hyphen `-` anywhere in the Omnibus GitLab tag.
 
+   {{< /alert >}}
+
    Examples of converting an upstream tag to an omnibus tag sequence:
 
    | upstream tag     | omnibus tag sequence                        |

doc/roles/_index.md

@@ -5,9 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: Omnibus GitLab High Availability Roles
 ---
 
-DETAILS:
-**Tier:** Free, Premium, Ultimate
-**Offering:** GitLab Self-Managed
+{{< details >}}
+
+- Tier: Free, Premium, Ultimate
+- Offering: GitLab Self-Managed
+
+{{< /details >}}
 
 Omnibus GitLab includes various software components/services to support running GitLab in
 a high availability configuration. By default, some of these supporting services

doc/settings/_index.md

@@ -5,9 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: Configuring a Linux package installation
 ---
 
-DETAILS:
-**Tier:** Free, Premium, Ultimate
-**Offering:** GitLab Self-Managed
+{{< details >}}
+
+- Tier: Free, Premium, Ultimate
+- Offering: GitLab Self-Managed
+
+{{< /details >}}
 
 - [Asset proxy server](https://docs.gitlab.com/ee/security/asset_proxy.html)
 - [Backups](backups.md)

doc/settings/actioncable.md

@@ -5,9 +5,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 title: Action Cable
 ---
 
-DETAILS:
-**Tier:** Free, Premium, Ultimate
-**Offering:** GitLab Self-Managed
+{{< details >}}
+
+- Tier: Free, Premium, Ultimate
+- Offering: GitLab Self-Managed
+
+{{< /details >}}
 
 Action Cable is a Rails engine that handles websocket connections.