Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioned documentation #532

Open
Sija opened this issue Dec 7, 2024 · 1 comment
Open

Versioned documentation #532

Sija opened this issue Dec 7, 2024 · 1 comment

Comments

@Sija
Copy link
Member

Sija commented Dec 7, 2024

It would be great to have online documentation versioned, in order to be able to link to it in our tooling, since rules and rule options are subject to change between versions.

References:

@Sija
Copy link
Member Author

Sija commented Dec 8, 2024

Gameplan draft:

  1. Remove everything from gh-pages branch
  2. Commit versions.json file (see for example Crystal's one), containing a single nightly entry
  3. Tweak the docs workflow by:
    • Adding --json-config-url=/ameba/versions.json argument to crystal docs invocation
    • Building the docs on every push to the master branch with target-folder: master
    • Building the docs on every release with target-folder: <version> & appending the version into the versions.json
  4. Run the workflow for master & every published version so far
  5. Create index.html in the root directory with redirect to /master

/cc @veelenga

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant