mirror of
https://opendev.org/openstack/puppet-openstack-guide.git
synced 2026-01-16 23:02:01 +00:00
Puppet OpenStack Project Guide
4573ad634f
Developers run all sorts of different tools within Git repositories, any of which can leave their own special trashfiles all over the place. We can't every hope to catalog them all, so better to recommend developers simply configure a global core.excludesfile to filter the irrelevant files which tend to get created by their personal choice of tools. Add a comment block explaining this, for clarity, and remove the one current editor-specific entry present. We can, and should of course, continue to list files created by the tools recommended by our workflow (test frameworks, documentation and packaging builds, et cetera). This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7 from the openstack-dev/cookiecutter repository. Change-Id: Id4a9ec69728f9b3bffcdd939503775a734e73db9 |
||
|---|---|---|
| doc | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| LICENSE | ||
| README.rst | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/puppet-openstack-guide.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
======================
Puppet OpenStack Guide
======================
To build the guide, execute the following command::
$ tox
After running ``tox``, the documentation will be available for viewing
in HTML format in the ``doc/build/`` directory. View these new documents
in your favorite web browser.