one icon indicating copy to clipboard operation
one copied to clipboard

Documentation images sources located on code repository

Open dann1 opened this issue 1 year ago • 0 comments

Situation

The opennebula documentation has its own dedicated repository. Some of the graph images linked on the rst files are generated with DOT file code which is hosted on the code repository.

For example, this image, is generated using this source file. The result is that two commits on different repositories are required whenever an update to the graph is needed.

For example

  • https://github.com/OpenNebula/docs/pull/2839
  • https://github.com/OpenNebula/one-ee/pull/2929

There is seemingly no reason as to why the image source is kept outside of the doc repository, other than having both doc and code in the same repo a long time ago. In the doc repo there is even a dedicated directory for source DOT files. At the moment only the packages graph is stored there.

Proposal

Move the share/doc/states directory on the code repository to the source/images/source directory on the doc repository.

dann1 avatar Feb 07 '24 22:02 dann1