https://github.com/cucumber/docs

Cucumber user documentation
https://github.com/cucumber/docs

bdd cucumber docs gherkin

Last synced: 28 days ago
JSON representation

Cucumber user documentation

• Host: GitHub
• URL: https://github.com/cucumber/docs
• Owner: cucumber
• License: mit
• Created: 2017-05-12T22:57:25.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T21:53:19.000Z (7 months ago)
• Last Synced: 2024-04-14T13:08:33.650Z (7 months ago)
• Topics: bdd, cucumber, docs, gherkin
• Language: CSS
• Homepage: https://cucumber.io/docs/installation/
• Size: 14 MB
• Stars: 139
• Watchers: 85
• Forks: 501
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![#StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)

# Cucumber Documentation

This repository contains the source code for [https://cucumber.io/docs](https://cucumber.io/docs).

If you want to read the docs, go there. ☝🏼

## Contributing Content

For small edits, the recommended way to contribute is via GitHub.

Each page in the documentation will have an **Edit** link for this purpose.

## Working locally

For bigger modifications, the recommended workflow is to edit the documentation

locally on your machine, and seeing the results in a web browser.

This involves getting the source code and building the documentation yourself.

# Get the source code

    git clone https://github.com/cucumber/docs

    cd docs

### View the site

The website is built with several tools that are distributed as a Docker image.

Install [Docker](https://docs.docker.com/install/) if you don't already have

it on your machine.

Build and serve the website:

    ./docker_shell.sh

Open a browser:

    http://localhost:1313

Changes to the contents will be automatically updated in the browser.

Try editing one of the pages under `content` and see for yourself!

### Build the site and check links

When you are done editing, build the site and check links:

    ./docker_shell.sh make clean

    ./docker_shell.sh make

    ./docker_shell.sh make htmlproofer

By default, external links are only checked in CI (because it takes a while).

To check external links locally:

    CI=true ./docker_shell.sh make htmlproofer

Links that are broken should be removed or replaced, even if they are only

temporarily broken. The reason for this is that broken links negatively affect

search engine rankings.

### Modify theme

See the [theme README](themes/cucumber-hugo/README.md)

## Architecture

The site is built with [Hugo](https://gohugo.io), a fast static site generator.

We have a custom-built theme for the site in `themes/cucumber-hugo`. This theme

is based on [Bulma](https://bulma.io/) - a lightweight CSS framework.

The online site is rebuild automatically whenever the git repository receives

new commits, either via a `git push`, or by modifying contents in the CMS.

The [Netlify CMS](https://www.netlifycms.org/) saves contents straight to GitHub

using the GitHub API.

## Continuous Deployment

GitHub will notify Netlify for every `git push` thanks to a [webhook](https://github.com/cucumber/docs.cucumber.io/settings/hooks).

Netlify will then build the site and

[deploy](https://app.netlify.com/sites/cucumber/deploys) it if the build is successful.

The build will check for broken links and other problems. Internal and external links are checked by [HTMLProofer](https://github.com/gjtorikian/html-proofer).

Occasionally, the build will fail due to external links being unavailable or giving a timeout. When that happens, please check if these external links are available and if so, 'Retry build' on Netlify.

You can discuss the documentation in the [Community Discord](https://cucumber.io/community#discord).