Skip to content

Allow to link to a specific version of the docs #47

@ypid-work

Description

@ypid-work

Is your feature request related to a problem? Please describe.

When an organization defines the (coding) style that should be followed, it comes in handy to just reference a few URLs and say we adhere to this and done. However, this external resource can change.

Describe the solution you'd like

The version of the docs should be selectable and pinable. I am not familiar with GitBook. https://docs.jabref.org/ top right version selector would be a start.

Additionally, the project would need to start doing releases following some like https://semver.org/spec/v2.0.0.html. Or at least have stable branches like stable-2.0, stable-2.1.

Note that https://semver.org/ has exactly the same requirement so they offer URLs like https://semver.org/spec/v2.0.0.html to pin the version.

Another solution could be to mirror https://github.com/antonbabenko/terraform-best-practices, render the docs and then point to this fixed version. Then git can be used to update and diff changes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions