Page MenuHomeDevCentral

Publish documentation through Jenkins
Open, NormalPublic

Description

Commit 621747ac938b updates the documentation.

https://cd.nasqueron.org/view/Documentation/ has jobs for other docs.nasqueron.org documentations resources, but not for salt-wrapper.

Could we create a Jenkins job to trigger ?

A Python virtual environment with Sphinx is needed, so create a virtualenv and run something like:

pip install sphinx
cd docs && make html

For the publish step, docs/_build/html -> Ysul /var/wwwroot/nasqueron.org/docs/salt-wrapper

Could we use Salt to build and deploy documentation?

Salt is already configured to build the documentation in webserver-content role.

So, alternatively, we can also do the deployment through Salt, by firing an event on the bus.

This event should then trigger a deployment on Ysul of the sls ID salt_wrapper_doc_build in roles/webserver-content/org/nasqueron/docs.

Currently, Ysul doesn't comply really well with I/O issues with the Salt bus, so it would need to be invoked through salt-call as a workaround. The deploy user doesn't have the sudo rights to do this:

ssh ysul sudo salt-call state.sls_id salt_wrapper_doc_build roles/webserver-content/org/nasqueron/docs

There is a decision to take at one moment where we do the build step:

  • if we choose to do it at Jenkins level, Salt should trigger builds from Jenkins instead of building itself
  • if we choose to do it at Salt level, we need a reactor to trigger events like the one described below (use case for thorium?)

Event Timeline

dereckson triaged this task as Normal priority.Mar 4 2023, 13:29
dereckson created this task.