hashbangcode / vlad

Vlad - Vagrant LAMP Ansible Drupal
173 stars 53 forks source link

Documentation: "Setting up local MySQL applications" should reference default variable documentation #235

Open rootwork opened 9 years ago

rootwork commented 9 years ago

In reference to "Setting up local MySQL applications":

https://vlad-docs.readthedocs.org/en/latest/applications/mysql/

When the decision was made to shorten the example.settings.yml file, the settings referenced under "Connecting MySQL GUI apps" were removed. (I'm not necessarily disagreeing with that decision, I'm just saying that's the effect it had.)

Now that those settings are not easily discoverable, I think this page should reference the default variables documentation:

https://vlad-docs.readthedocs.org/en/latest/usage/variables/

I only discovered this because I saw the setup reference the file vlad/playbooks/vars/dummy_settings.yml, which points to this documentation page.

I think the actual documentation pages for these settings (perhaps not just MySQL) should explicitly point people to that default variable documentation.

Thanks for such a great and long-standing project!

philipnorton42 commented 9 years ago

All really good points. We already reference the settings page from within the example setting file (example.settings.yml) but it makes sense to increase the interconnectedness of the documentation.

dixhuit commented 9 years ago

@rootwork Do you fancy submitting a PR to the Vlad docs repo for this? The docs are complied with MkDocs but you don't need to have it installed, so long as you can understand basic markdown, you know everything you need to help us edit the docs directly.