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

We should version documentation #147

Closed
bartoszmajsak opened this Issue Sep 13, 2017 · 1 comment

Comments

Projects
None yet
1 participant
@bartoszmajsak
Member

bartoszmajsak commented Sep 13, 2017

Issue Overview

We don't version documentation.

Expected Behaviour

Each release creates versioned documentation, so it's available under e.g. http://arquillian.org/0.0.1/ (this one I've just manually fixed). We should extend our build script (.travis.yml) to perform this for each and every release. Once we have this in place we should retrofit it to other repositories (e.g. Cube was way outdated too, but I fixed that yesterday).

Current Behaviour

Only latest documentation is built.

Suboptimal fix

For each and every push we can run following script (adjusted to travis environment / docker), but it has obvious disadvantages.

for tag in `git tag -l`;
do
 git co $tag
 asciidoctor README.adoc -a asciidoctor-source=./docs -o gh-pages/$(git tag --points-at HEAD)/index.html
done

And then commit.

@bartoszmajsak

This comment has been minimized.

Show comment
Hide comment
@bartoszmajsak

bartoszmajsak Sep 21, 2017

Member

Addition - render documentation for a PR to preview and catch regressions

Member

bartoszmajsak commented Sep 21, 2017

Addition - render documentation for a PR to preview and catch regressions

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