spockframework / spockframework/spock

Documentation needs an index page for the different versions of the documentation

Open
#612 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
3.6k
Forks
483
PR merge metrics
No merged PRs in 30d

Description

Right now docs.spockframework.org will redirect to the latest version of the documentation.

It is desired to have an automated way to create an index page and add a link back to this index page on all versions of the documentation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the redirect behavior at docs.spockframework.org and how the different documentation versions are published. Done means an automated index lists the available versions and every version includes a link back to that index.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.