Publish new documentation automatically #529

New Issue

Open

opened 2023-03-13 14:28:50 +00:00 by quentin · 1 comment

quentin commented

2023-03-13 14:28:50 +00:00

Owner

I think it makes even more sense currently, as huge modifications on Garage are not prepared on main but on a dedicated branch (cf 0.9), so it would not be published instantaneously to the website. And more generally, for the rare case where we plan to have a huge breaking change, we can work on the doc on a dedicated branch.

If we agree that we want to proceed like this, ie. publishing doc as fast as possible on garagehq, I will probably add a nightly build to the garagehq repository that will update the Garage git submodule.

cc: @lx

Today we are manually updating the documentation website from time to time. I think it can be frustrating to wait months to see your contribution online. Originally, we took this decision as we did not want to publish documentation for unreleased feature. But in the end, I think that starting from now, it's just easier and better to tag the paragraph/section with the minimal version of Garage that supports this feature. This is what Hashicorp is doing for Nomad for example. I think it makes even more sense currently, as huge modifications on Garage are not prepared on main but on a dedicated branch (cf 0.9), so it would not be published instantaneously to the website. And more generally, for the rare case where we plan to have a huge breaking change, we can work on the doc on a dedicated branch. If we agree that we want to proceed like this, ie. publishing doc as fast as possible on garagehq, I will probably add a nightly build to the garagehq repository that will update the Garage git submodule. cc: @lx

quentin added the

Ideas

Documentation

labels 2023-03-13 14:28:50 +00:00

quentin changed title from ~~Regenerate documentation automatically~~ to Publish new documentation automatically

2023-03-13 14:29:07 +00:00

lx commented

2023-03-13 15:54:26 +00:00

Owner

it's just easier and better to tag the paragraph/section with the minimal version of Garage that supports this feature

Do we have a CI system that is robust enough to make this work? I know we did some tests with StaticCMS, is the CI running properly or are some jobs getting skipped occasionnally? Because the Garage CI has lots of issues

> it's just easier and better to tag the paragraph/section with the minimal version of Garage that supports this feature +1 Do we have a CI system that is robust enough to make this work? I know we did some tests with StaticCMS, is the CI running properly or are some jobs getting skipped occasionnally? Because the Garage CI has lots of issues