Skip to content

gatling/gatling.io-doc

Repository files navigation

Gatling documentation

Prerequisites

You need Go and Hugo installed.

Make sure to install the extended version of Hugo.

Installation

Either way, once launched, you can visit at http://localhost:1313

Docker-compose

This project provide a docker-compose.yml configuration

docker-compose up

Local

./bin/entrypoint.sh

Or manually:

hugo mod get -u
hugo mod npm pack
npm install
hugo server

Troubleshooting

Invalid version: unknown revision

In case of issue such as:

go: github.com/gatling/[email protected]: invalid version: unknown revision c0fbf7866574

In the file go.mod, in the last line (with the require keyword), replace the hash with main:

 module github.com/gatling/gatling

 go 1.21

-require github.com/gatling/gatling.io-doc-theme v0.0.0-20240220083005-6f637476df1d // indirect
+require github.com/gatling/gatling.io-doc-theme main // indirect

Then, run hugo mod get -u.

Template for shortcode "img" not found

In case of issue such as:

failed to extract shortcode: template for shortcode "img" not found

Run hugo mod clean.

Update Hugo

If you continue to encounter errors, check your installation of Hugo is up-to-date and that you are using the extended edition.

Check the official documentation for all the details.