Merge branch 'speed-up-link-check' into 'main'

Speed up nanoc by only testing root html files

See merge request gitlab-org/gitlab-docs!2418

2 files changed, 28 insertions, 25 deletions

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 40af1619..2532946b 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -240,6 +240,10 @@ test_internal_links_and_anchors:
     - .cache_gem
   stage: test
   script:
+    # Only check files in top-level directories. This means a much faster and less repetitive check of global navigation links.
+    - echo "  all:" >> nanoc.yaml
+    - echo "    exclude_files:" >> nanoc.yaml
+    - echo "      - '\/(ee|runner|omnibus|charts)\/.*\/.*'" >> nanoc.yaml
     - "parallel time bundle exec nanoc check ::: internal_links internal_anchors"
 
 #
diff --git a/nanoc.yaml b/nanoc.yaml
index 76534192..79bbd23f 100644
--- a/nanoc.yaml
+++ b/nanoc.yaml
@@ -30,6 +30,8 @@ text_extensions: [
 output_dir: public
 index_filenames: ['index.html']
 enable_output_diff: false
+breadcrumbs: false
+debug: false
 
 domain: docs.gitlab.com
 base_url: https://docs.gitlab.com
@@ -74,6 +76,28 @@ data_sources:
     encoding: utf-8
     identifier_type: full
 
+products:
+  ee:
+    slug: 'ee'
+    repo: 'https://gitlab.com/gitlab-org/gitlab.git'
+    project_dir: '../gitlab'
+    content_dir: '../gitlab/doc'
+  runner:
+    slug: 'runner'
+    repo: 'https://gitlab.com/gitlab-org/gitlab-runner.git'
+    project_dir: '../gitlab-runner'
+    content_dir: '../gitlab-runner/docs'
+  omnibus:
+    slug: 'omnibus'
+    repo: 'https://gitlab.com/gitlab-org/omnibus-gitlab.git'
+    project_dir: '../omnibus-gitlab'
+    content_dir: '../omnibus-gitlab/doc'
+  charts:
+    slug: 'charts'
+    repo: 'https://gitlab.com/gitlab-org/charts/gitlab.git'
+    project_dir: '../charts-gitlab'
+    content_dir: '../charts-gitlab/doc'
+
 checks:
   internal_links:
     exclude:
@@ -115,28 +139,3 @@ checks:
       # Some links require authentication
       - 'https:\/\/dashboards.gitlab.com\/.*'
       - 'https:\/\/ops.gitlab.net\/.*'
-
-breadcrumbs: false
-debug: false
-
-products:
-  ee:
-    slug: 'ee'
-    repo: 'https://gitlab.com/gitlab-org/gitlab.git'
-    project_dir: '../gitlab'
-    content_dir: '../gitlab/doc'
-  runner:
-    slug: 'runner'
-    repo: 'https://gitlab.com/gitlab-org/gitlab-runner.git'
-    project_dir: '../gitlab-runner'
-    content_dir: '../gitlab-runner/docs'
-  omnibus:
-    slug: 'omnibus'
-    repo: 'https://gitlab.com/gitlab-org/omnibus-gitlab.git'
-    project_dir: '../omnibus-gitlab'
-    content_dir: '../omnibus-gitlab/doc'
-  charts:
-    slug: 'charts'
-    repo: 'https://gitlab.com/gitlab-org/charts/gitlab.git'
-    project_dir: '../charts-gitlab'
-    content_dir: '../charts-gitlab/doc'