docs icon indicating copy to clipboard operation
docs copied to clipboard

Documentation versioning

Open brunograz opened this issue 7 years ago • 3 comments

Feature request

It would be nice to have docs for different concourse versions, like a dropdown list box where the documentation for a specific concourse version can be selected.

This would make it easier to check if certain features are available for that version. Take resource_types params as an example, it was added only in v3.7.0 and it is not available for older versions.

brunograz avatar Feb 27 '18 10:02 brunograz

Yes! sorry, just commenting to show that we haven't forgotten about this. As we move through more versions of Concourse, i think its going to be really important to differentiate what docs are relevant to what versions of Concourse. Something we've talked about in the past is tagging our docs repo and being able to deploy each version on different subdomains, that way we can at least point folks to older docs without asking them to compile it for themselves locally!

jama22 avatar Sep 25 '18 14:09 jama22

I believe this PR fixes this #152

marco-m avatar Apr 01 '19 20:04 marco-m

The best I have seen so far in supporting versioned documentation is Antora. Now adopting this for Concourse would be a major change because:

  • content is written in AsciiDoc markup
  • recreation of the styling
  • it would only work from the current version on, unless the transformation would be "back ported" to older version branches

Benefit is that content can come from different repositories and branches or tags in each of these repositories.

ringods avatar Oct 22 '21 07:10 ringods