Commit d30d4658 authored by Russell Dickenson's avatar Russell Dickenson

Merge branch 'eread/resolve-remaining-markdownlint-cli-0_29_0-issues' into 'master'

Resolve remaining compatibility issues with markdownlint-cli 0.29.0

See merge request gitlab-org/gitlab!73442
parents ba4f48a7 9b32139b
...@@ -6,12 +6,18 @@ comments: false ...@@ -6,12 +6,18 @@ comments: false
description: 'Learn how to use and administer GitLab, the most scalable Git-based fully integrated platform for software development.' description: 'Learn how to use and administer GitLab, the most scalable Git-based fully integrated platform for software development.'
--- ---
<!-- markdownlint-disable MD044 -->
<!-- MD044/proper-names test disabled after this line to make page compatible with markdownlint-cli 0.29.0. -->
<!-- See https://docs.gitlab.com/ee/development/documentation/testing.html#disable-markdownlint-tests -->
<div class="d-none"> <div class="d-none">
<h3>Visit <a href="https://docs.gitlab.com/ee/">docs.gitlab.com</a> for the latest version <h3>Visit <a href="https://docs.gitlab.com/ee/">docs.gitlab.com</a> for the latest version
of this help information with enhanced navigation, discoverability, and readability.</h3> of this help information with enhanced navigation, discoverability, and readability.</h3>
</div> </div>
<!-- the div above will not display on the docs site but will display on /help --> <!-- the div above will not display on the docs site but will display on /help -->
<!-- markdownlint-enable MD044 -->
# GitLab Docs # GitLab Docs
Welcome to [GitLab](https://about.gitlab.com/) documentation. Welcome to [GitLab](https://about.gitlab.com/) documentation.
......
...@@ -60,6 +60,10 @@ maximum of two directory levels from the repository's root. For example, the ...@@ -60,6 +60,10 @@ maximum of two directory levels from the repository's root. For example, the
`gemnasium-dependency_scanning` job is enabled if a repository contains either `Gemfile`, `gemnasium-dependency_scanning` job is enabled if a repository contains either `Gemfile`,
`api/Gemfile`, or `api/client/Gemfile`, but not if the only supported dependency file is `api/v1/client/Gemfile`. `api/Gemfile`, or `api/client/Gemfile`, but not if the only supported dependency file is `api/v1/client/Gemfile`.
<!-- markdownlint-disable MD044 -->
<!-- MD044/proper-names test disabled after this line to make page compatible with markdownlint-cli 0.29.0. -->
<!-- See https://docs.gitlab.com/ee/development/documentation/testing.html#disable-markdownlint-tests -->
The following languages and dependency managers are supported: The following languages and dependency managers are supported:
<style> <style>
...@@ -246,6 +250,8 @@ table.supported-languages ul { ...@@ -246,6 +250,8 @@ table.supported-languages ul {
</tbody> </tbody>
</table> </table>
<!-- markdownlint-enable MD044 -->
### Notes regarding supported languages and package managers ### Notes regarding supported languages and package managers
1. Although Gradle with Java 8 is supported, there are other issues such that Android project builds are not supported at this time. Please see the backlog issue [Android support for Dependency Scanning (gemnasium-maven)](https://gitlab.com/gitlab-org/gitlab/-/issues/336866) for more details. 1. Although Gradle with Java 8 is supported, there are other issues such that Android project builds are not supported at this time. Please see the backlog issue [Android support for Dependency Scanning (gemnasium-maven)](https://gitlab.com/gitlab-org/gitlab/-/issues/336866) for more details.
......
...@@ -13,29 +13,17 @@ the CI/CD pipeline to generate a Pages website. ...@@ -13,29 +13,17 @@ the CI/CD pipeline to generate a Pages website.
Use a `.gitlab-ci.yml` template when you have an existing project that you want to add a Pages site to. Use a `.gitlab-ci.yml` template when you have an existing project that you want to add a Pages site to.
Your GitLab repository should contain files specific to an SSG, or plain HTML. Your GitLab repository should contain files specific to an SSG, or plain HTML. After you complete
After you complete these steps, you may need to do additional these steps, you may have to do additional configuration for the Pages site to generate properly.
configuration for the Pages site to generate properly.
1. On the left sidebar, select **Project information**. 1. On the left sidebar, select **Project information**.
1. Click **Set up CI/CD**. 1. Click **Set up CI/CD**. If this button is not available, CI/CD is already configured for your project.
You may want to browse the `.gitlab-ci.yml` files [in these projects instead](https://gitlab.com/pages).
![setup GitLab CI/CD](../img/setup_ci_v13_1.png)
If this button is not available, CI/CD is already configured for
your project. You may want to browse the `.gitlab-ci.yml` files
[in these projects instead](https://gitlab.com/pages).
1. From the **Apply a template** list, choose a template for the SSG you're using. 1. From the **Apply a template** list, choose a template for the SSG you're using.
You can also choose plain HTML. You can also choose plain HTML. If you don't find a corresponding template, you can view the
![gitlab-ci templates](../img/choose_ci_template_v13_1.png)
If you don't find a corresponding template, you can view the
[GitLab Pages group of sample projects](https://gitlab.com/pages). [GitLab Pages group of sample projects](https://gitlab.com/pages).
These projects contain `.gitlab-ci.yml` files that you can modify for your needs. These projects contain `.gitlab-ci.yml` files that you can modify for your needs.
You can also [learn how to write your own `.gitlab-ci.yml` file for GitLab Pages](pages_from_scratch.md). You can also [learn how to write your own `.gitlab-ci.yml` file for GitLab Pages](pages_from_scratch.md).
1. Save and commit the `.gitlab-ci.yml` file. 1. Save and commit the `.gitlab-ci.yml` file.
If everything is configured correctly, the site can take approximately 30 minutes to deploy. If everything is configured correctly, the site can take approximately 30 minutes to deploy.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment