cfengine / cf-bottom

__init__
MIT License
3 stars 12 forks source link

Added Jenkins support for documentation and documentation-generator #63

Closed nickanderson closed 2 years ago

Lex-2008 commented 3 years ago

Note that by default, Jenkins doesn't build docs. For that, you need to check a checkbox (pass extra argument in case of cf-bottom).

Also note that docs use a different version numbering scheme from the rest of repos: 3.18 vs 3.18.x. This should be taken care of, probably.

Doc builds then will likely appear in dirs like http://buildcache.cloud.cfengine.com/packages/build-documentation-master/ and will be picked up to be shown on main docs.cfengine.com website, how convenient! (Yes, PRs to 3.18 branch will appear at https://docs.cfengine.com/docs/3.18/ - convenient, huh?)

olehermanse commented 3 years ago

Note that by default, Jenkins doesn't build docs. For that, you need to check a checkbox (pass extra argument in case of cf-bottom).

@Lex-2008 is docs build expensive / slow? If not perhaps it should be enabled by default.

Lex-2008 commented 3 years ago

well, it takes some time, yes - also it spins up an extra VM in AWS which takes some time to spin up. Not as slow as exotics, but still possible to notice.