Please help fill in https://www.mediawiki.org/wiki/MediaWiki-Vagrant/Roles:)
It's hard to know what a role does precisely without more docs than are provided via the 'vagrant list-roles' command. Maybe we could add a description to the list there? First step would be getting content I guess.
On Mon, Apr 14, 2014 at 4:35 PM, Steven Walling swalling@wikimedia.org wrote:
Please help fill in https://www.mediawiki.org/wiki/MediaWiki-Vagrant/Roles:)
It's hard to know what a role does precisely without more docs than are provided via the 'vagrant list-roles' command. Maybe we could add a description to the list there? First step would be getting content I guess.
I took a shot at creating jenkins configuration [0] that would build and publish documentation based on puppet manifests themselves. This seems like a better long term solution to the problem. I'm all for documenting things on wiki but in my experience the closer the documentation is to the implementation the more likely it will be updated when the implementation changes.
[0]: https://gerrit.wikimedia.org/r/#/c/125919/
On Mon, Apr 14, 2014 at 6:19 PM, Bryan Davis bd808@wikimedia.org wrote:
I took a shot at creating jenkins configuration [0] that would build and publish documentation based on puppet manifests themselves. This seems like a better long term solution to the problem. I'm all for documenting things on wiki but in my experience the closer the documentation is to the implementation the more likely it will be updated when the implementation changes.
This job is enabled in Jenkins now. You can read the documentation of just the roles [1] and/or the full puppet doc [2] for all classes included in MediaWiki-Vagrant puppet configuration.
[1]: https://doc.wikimedia.org/mediawiki-vagrant/classes/__site__/role.html [2]: https://doc.wikimedia.org/mediawiki-vagrant/
Bryan
On Tue, Apr 15, 2014 at 4:23 PM, Bryan Davis bd808@wikimedia.org wrote:
This job is enabled in Jenkins now. You can read the documentation of just the roles [1] and/or the full puppet doc [2] for all classes included in MediaWiki-Vagrant puppet configuration.
Cool! Feel free to replace the on-wiki doc with links to this, if you want.
wikitech-l@lists.wikimedia.org