summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2017-03-30 09:34:43 +0000
committerRémy Coutable <remy@rymai.me>2017-03-30 09:34:43 +0000
commit0b1c7eead2da24923be945a953e4d38ac354e3b5 (patch)
treec343df807001c7767e52c2a0d955b19f7c12303c
parent68aa43fdbde279b2d990e4108da03c4e6bd8034d (diff)
downloadgitlab-ce-0b1c7eead2da24923be945a953e4d38ac354e3b5.tar.gz
Test docs internal links check
-rw-r--r--.gitlab-ci.yml25
-rw-r--r--doc/administration/high_availability/database.md4
-rw-r--r--doc/development/fe_guide/testing.md4
3 files changed, 27 insertions, 6 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index ff4da3a8884..476307e7076 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -292,14 +292,35 @@ rake karma:
paths:
- coverage-javascript/
-lint-doc:
+docs:check:apilint:
+ image: "phusion/baseimage"
stage: test
<<: *dedicated-runner
- image: "phusion/baseimage:latest"
+ variables:
+ GIT_DEPTH: "3"
+ cache: {}
+ dependencies: []
before_script: []
script:
- scripts/lint-doc.sh
+docs:check:links:
+ image: "registry.gitlab.com/gitlab-org/gitlab-build-images:nanoc-bootstrap-ruby-2.4-alpine"
+ stage: test
+ <<: *dedicated-runner
+ variables:
+ GIT_DEPTH: "3"
+ cache: {}
+ dependencies: []
+ before_script: []
+ script:
+ - mv doc/ /nanoc/content/
+ - cd /nanoc
+ # Build HTML from Markdown
+ - bundle exec nanoc
+ # Check the internal links
+ - bundle exec nanoc check internal_links
+
bundler:check:
stage: test
<<: *dedicated-runner
diff --git a/doc/administration/high_availability/database.md b/doc/administration/high_availability/database.md
index cf3aca106e9..c22b1af8bfb 100644
--- a/doc/administration/high_availability/database.md
+++ b/doc/administration/high_availability/database.md
@@ -13,8 +13,8 @@ Database Service (RDS) that runs PostgreSQL.
If you use a cloud-managed service, or provide your own PostgreSQL:
-1. Setup PostgreSQL according to the
- [database requirements document](doc/install/requirements.md#database).
+1. Setup PostgreSQL according to the
+ [database requirements document](../../install/requirements.md#database).
1. Set up a `gitlab` username with a password of your choice. The `gitlab` user
needs privileges to create the `gitlabhq_production` database.
1. Configure the GitLab application servers with the appropriate details.
diff --git a/doc/development/fe_guide/testing.md b/doc/development/fe_guide/testing.md
index bb6adeacc4c..8d3513d3566 100644
--- a/doc/development/fe_guide/testing.md
+++ b/doc/development/fe_guide/testing.md
@@ -7,7 +7,7 @@ feature tests with Capybara for integration testing.
Feature tests need to be written for all new features. Regression tests ought
to be written for all bug fixes to prevent them from recurring in the future.
-See [the Testing Standards and Style Guidelines](/doc/development/testing.md)
+See [the Testing Standards and Style Guidelines](../testing.md)
for more information on general testing practices at GitLab.
## Karma test suite
@@ -48,7 +48,7 @@ remove these directives when you commit your code.
Information on setting up and running RSpec integration tests with
[Capybara][capybara] can be found in the
-[general testing guide](/doc/development/testing.md).
+[general testing guide](../testing.md).
## Gotchas