diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 7a1b3b13cb137157404fbb5752e76ac789da672f..d9a9a5d0d70be015c8a2df3341c14eb8040cb423 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -126,6 +126,20 @@ check_docs_markdown: # Check links - lychee --offline --include-fragments docs/**/*.md *.md +check_docs_hugo: + image: registry.gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/docs-gitlab-com-builder:hugo-0.150.1 + extends: .documentation + before_script: + - git clone --depth 1 https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com.git + - cd docs-gitlab-com + - make add-latest-icons + script: + # Test that Hugo will build + - hugo --gc --printPathWarnings --panicOnWarning --environment test + # Test for invalid index pages + # See https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/blob/main/scripts/check-index-filenames.sh + - make check-index-pages SEARCH_DIR="../docs/source" + check_go_generated_code: extends: - .go-cache diff --git a/docs/source/_index.md b/docs/source/_index.md index 3d3217c6f5f1ae797520cc5e8309d3b89f43e13a..f396c04eb539fc127126cf0f468f70c739e5df6d 100644 --- a/docs/source/_index.md +++ b/docs/source/_index.md @@ -10,7 +10,7 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -![GLab](../assets/glab-logo.png) +![GLab](img/glab_logo.png) GLab is an open source GitLab CLI tool. It brings GitLab to your terminal, next to where you are already working with `git` and your code, without switching between windows and browser tabs. While it's powerful for issues and merge requests, `glab` does even more: @@ -22,7 +22,7 @@ GLab is an open source GitLab CLI tool. It brings GitLab to your terminal, next `glab` is available for repositories hosted on GitLab.com, GitLab Dedicated, and GitLab Self-Managed. It supports multiple authenticated GitLab instances, and automatically detects the authenticated hostname from the remotes available in your working Git directory. -![command example](../assets/glabgettingstarted.gif) +![command example](img/glabgettingstarted.gif) ## Install the CLI diff --git a/docs/source/img/glab_logo.png b/docs/source/img/glab_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..d7935c65edbba84eaffc3813b8fc1520d9d21692 Binary files /dev/null and b/docs/source/img/glab_logo.png differ diff --git a/docs/source/img/glabgettingstarted.gif b/docs/source/img/glabgettingstarted.gif new file mode 100644 index 0000000000000000000000000000000000000000..cf335294e41b1cbff15c63954eb91e3ff2fbb9b0 Binary files /dev/null and b/docs/source/img/glabgettingstarted.gif differ