Closed gavanderhoorn closed 6 years ago
I'm also wondering whether it wouldn't make sense to migrate most of this readme to that of the buildfarm_deployment_config
repository.
'm also wondering whether it wouldn't make sense to migrate most of this readme to that of the buildfarm_deployment_config repository.
I think trying to consolidate documentation into one repository or the other is advantageous. But I think it might be easier to to move documentation to this repository, with the rationale being that the public buildfarm_deployment_config repository is at times a shallow copy of, and at other times a testing ground for, the private repo which houses the config for build.ros.org itself. Keeping those repositories in sync is made slightly harder when there's different documentation for internal or general consumption. I think it's worthwhile to try and migrate all public documentation to this repository.
Makes sense.
Reason I asked is that the readme
in this repository seems to be documenting things that are actually found in buildfarm_deployment_config
, which I thought was a bit weird.
The strange formatting of the readme always confuses me, especially the many bullets in the
Updating values
sections where the text of the next item is actually the description of the current item.Also removed some (probably?) reStructuredText remnants and made sure that all sentences start on a new line.
Note: this does not update the readme to actually correspond to the changed hiera setup in
buildfarm_deployment_config
. I don't yet have enough understanding of those, but figured this might be a good first step towards making the readme more useful.