From 86bb0cd52f25d18ec2eebd9b6ec5bb7804769ce4 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick <aimeeu.opensource@gmail.com> Date: Mon, 1 Apr 2024 22:32:06 +0000 Subject: [PATCH] Add test jobs section: change test-markdown to lint-markdown Text now matches name used in YAML --- doc/ci/quick_start/tutorial.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/ci/quick_start/tutorial.md b/doc/ci/quick_start/tutorial.md index bb766436379a8..1b95c7d456c2e 100644 --- a/doc/ci/quick_start/tutorial.md +++ b/doc/ci/quick_start/tutorial.md @@ -216,8 +216,16 @@ and view the pipeline details from the **Pipelines** list. Verify that: - The two jobs run in different stages, `build` and `deploy`. - After the `pages` job completes a `pages-deploy` job appears, which is the GitLab process that deploys the Pages site. When that job completes, you can visit your new Docusaurus - site. The Pages documentation explains [the URL formatting](../../user/project/pages/getting_started_part_one.md#gitlab-pages-default-domain-names), - which should be similar to `https://<my-username>.gitlab.io/<my-pipeline-tutorial-project>/`. + site. + +To view your site: + +- On the left sidebar, select **Deploy > Pages**. +- Make sure **Use unique domain** is off. +- Under **Access pages**, select the link. The URL format should be similar to: `https://<my-username>.gitlab.io/<project-name>`. For more information, see [GitLab Pages default domain names](../../user/project/pages/getting_started_part_one.md#gitlab-pages-default-domain-names). + +NOTE: +If you need to [use unique domains](../../user/project/pages/introduction.md#enable-unique-domains), in `docusaurus.config.js`, set `baseUrl`: to `/`. ## Add test jobs @@ -301,7 +309,7 @@ pages: Commit this pipeline configuration to the default branch, and view the pipeline details. -- The `test-markdown` job fails because the sample Markdown violates the default +- The `lint-markdown` job fails because the sample Markdown violates the default markdownlint rules, but is allowed to fail. You can: - Ignore the violations for now. They do not need to be fixed as part of the tutorial. - Fix the Markdown file violations. Then you can change `allow_failure` to `false`, -- GitLab