Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.gitlab.com/development/documentation/testing/links/ below:

Documentation and UI link tests

Help us learn about your current experience with the documentation.

.

For testing:

• Relative links between documentation files, we use Lychee.
• Links to documentation from the GitLab UI, we use haml-lint, eslint, and rubocop.

To run the relative link test locally, you can either:

• Run the link check for a single project that contains documentation.
• Run the link check across entire local copy of the GitLab documentation site.

To check the links on a single project:

1. Install Lychee.
2. Change into the root directory of the project.
3. Run lychee --offline --include-fragments <doc_directory> where <doc_directory> it the directory that contains documentation to check. For example: lychee --offline --include-fragments doc.

To check links on the entire GitLab documentation site:

1. Make sure you have all the documentation projects cloned in the same directory as your docs-gitlab-com clone. You can run make clone-docs-projects to clone any projects you don’t have in that location.
2. Go to the docs-gitlab-com directory.
3. Run hugo, which builds the GitLab Docs site.
4. Run lychee --offline public to check links.

To test documentation links from GitLab code files locally, you can run

• eslint: For frontend (.js and .vue) files.
• rubocop: For .rb and .haml files.

1. Open the gitlab directory in a terminal window.

2. Run:

   scripts/frontend/lint_docs_links.mjs

If you receive an error the first time you run this test, run yarn install, which installs the dependencies for GitLab, and try again.

1. Install RuboCop

2. Open the gitlab directory in a terminal window.

3. To run the check on all Ruby files:

   rubocop --only Gitlab/DocumentationLinks/Link

   To run the check on a single Ruby file:

   rubocop --only Gitlab/DocumentationLinks/Link path/to/ruby/file.rb

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4