From 75395c970611644121dcc426ea421166cc737ed6 Mon Sep 17 00:00:00 2001 From: Travis Truman Date: Wed, 2 Mar 2016 11:26:18 -0500 Subject: [PATCH] Doc and configuration for independent repository Change-Id: Ibf90f1a32fb919bc75e178047f4e1ade20dd303e --- CONTRIBUTING.rst | 54 ++++++++++++++++++++++++++++---------------- README.rst | 6 ++--- doc/Makefile | 8 +++---- doc/source/conf.py | 28 +++++++++++------------ doc/source/index.rst | 15 +----------- setup.cfg | 4 ++-- 6 files changed, 59 insertions(+), 56 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e989c3b1..dccff0b7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,51 +1,62 @@ -TEMPLATE -######## +OpenStack-Ansible Galera Server +############################### :tags: openstack, cloud, ansible :category: \*nix -contributor guidelines +Contributor Guidelines ^^^^^^^^^^^^^^^^^^^^^^ Filing Bugs ----------- -Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible" +Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net +/openstack-ansible" -When submitting a bug, or working on a bug, please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. +When submitting a bug, or working on a bug, please ensure the following +criteria are met: + * The description clearly states or describes the original problem or root + cause of the problem. * Include historical information on how the problem was identified. * Any relevant logs are included. - * The provided information should be totally self-contained. External access to web services/sites should not be needed. + * The provided information should be totally self-contained. External + access to web services/sites should not be needed. * Steps to reproduce the problem if possible. Submitting Code --------------- -Changes to the project should be submitted for review via the Gerrit tool, following -the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow" +Changes to the project should be submitted for review via the Gerrit tool, +following the workflow documented at: +"http://docs.openstack.org/infra/manual/developers.html#development-workflow" -Pull requests submitted through GitHub will be ignored and closed without regard. +Pull requests submitted through GitHub will be ignored and closed without +regard. Extra ----- -Tags: - If it's a bug that needs fixing in a branch in addition to Master, add a '\-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete. +Tags: + If it's a bug that needs fixing in a branch in addition to Master, add a + '\-backport-potential' tag (eg ``juno-backport-potential``). + There are predefined tags that will autocomplete. Status: Please leave this alone, it should be New till someone triages the issue. Importance: - Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures. + Should only be touched if it is a Blocker/Gating issue. If it is, please + set to High, and only use Critical if you have found a bug that can take + down whole infrastructures. Style guide ----------- -When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format. +When creating tasks and other roles for use in Ansible please create then +using the YAML dictionary format. Example YAML dictionary format: .. code-block:: yaml @@ -69,17 +80,22 @@ Example **NOT** in YAML dictionary format: - some-other-tag -Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module. +Usage of the ">" and "|" operators should be limited to Ansible conditionals +and command modules such as the ansible ``shell`` module. Issues ------ -When submitting an issue, or working on an issue please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. +When submitting an issue, or working on an issue please ensure the following +criteria are met: + * The description clearly states or describes the original problem or root + cause of the problem. * Include historical information on how the problem was identified. * Any relevant logs are included. - * If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR). - * The provided information should be totally self-contained. External access to web services/sites should not be needed. + * If the issue is a bug that needs fixing in a branch other than Master, + add the ‘backport potential’ tag TO THE ISSUE (not the PR). + * The provided information should be totally self-contained. External + access to web services/sites should not be needed. * If the issue is needed for a hotfix release, add the 'expedite' label. * Steps to reproduce the problem if possible. diff --git a/README.rst b/README.rst index 7d9c637a..0b9fe9b0 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,9 @@ -OpenStack Galera Server -####################### +OpenStack-Ansible Galera Server +############################### :tags: openstack, galera, server, cloud, ansible :category: \*nix -Role for the installation and installation of a Galera Cluster powered by MariaDB +Ansible role to install and configure a Galera cluster powered by MariaDB .. code-block:: yaml diff --git a/doc/Makefile b/doc/Makefile index 34d741fb..70d7021f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -87,9 +87,9 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/openstack-ansible-TEMPLATE.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/openstack-ansible-galera_server.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/openstack-ansible-TEMPLATE.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/openstack-ansible-galera_server.qhc" applehelp: $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp @@ -104,8 +104,8 @@ devhelp: @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/openstack-ansible-TEMPLATE" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/openstack-ansible-TEMPLATE" + @echo "# mkdir -p $$HOME/.local/share/devhelp/openstack-ansible-galera_server" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/openstack-ansible-galera_server" @echo "# devhelp" epub: diff --git a/doc/source/conf.py b/doc/source/conf.py index 84cdbeea..e631c4b1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- # -# openstack-ansible-TEMPLATE documentation build configuration file, created by +# openstack-ansible-galera_server documentation build configuration file, created by # sphinx-quickstart on Mon Apr 13 20:42:26 2015. # # This file is execfile()d with the current directory set to its @@ -32,7 +32,7 @@ extensions = [ ] # The link to the browsable source code (for the left hand menu) -oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/openstack-ansible-TEMPLATE' +oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/openstack-ansible-galera_server' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -49,9 +49,9 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'openstack-ansible-TEMPLATE' -copyright = '2015, openstack-ansible-TEMPLATE contributors' -author = 'openstack-ansible-TEMPLATE contributors' +project = 'openstack-ansible-galera_server' +copyright = '2015, openstack-ansible-galera_server contributors' +author = 'openstack-ansible-galera_server contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -203,7 +203,7 @@ html_static_path = ['_static'] # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'openstack-ansible-TEMPLATEdoc' +htmlhelp_basename = 'openstack-ansible-galera_serverdoc' # -- Options for LaTeX output --------------------------------------------- @@ -225,9 +225,9 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'openstack-ansible-TEMPLATE.tex', - 'openstack-ansible-TEMPLATE Documentation', - 'openstack-ansible-TEMPLATE contributors', 'manual'), + (master_doc, 'openstack-ansible-galera_server.tex', + 'openstack-ansible-galera_server Documentation', + 'openstack-ansible-galera_server contributors', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -256,8 +256,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'openstack-ansible-TEMPLATE', - 'openstack-ansible-TEMPLATE Documentation', + (master_doc, 'openstack-ansible-galera_server', + 'openstack-ansible-galera_server Documentation', [author], 1) ] @@ -271,9 +271,9 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'openstack-ansible-TEMPLATE', - 'openstack-ansible-TEMPLATE Documentation', - author, 'openstack-ansible-TEMPLATE', 'One line description of project.', + (master_doc, 'openstack-ansible-galera_server', + 'openstack-ansible-galera_server Documentation', + author, 'openstack-ansible-galera_server', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/source/index.rst b/doc/source/index.rst index e2af80cb..38ba8043 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,14 +1 @@ -TEMPLATE Docs -============= - -Tell us what the role is supposed to do? - -Basic Role Example -^^^^^^^^^^^^^^^^^^ - -Tell us how to use the role. - -.. code-block:: yaml - - - role: "$ROLENAME" - ROLE_VARS... +.. include:: ../../README.rst \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index 4a243839..830cc29b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] -name = openstack-ansible-TEMPLATE -summary = TEMPLATE for OpenStack Ansible +name = openstack-ansible-galera_server +summary = Galera Server role for OpenStack-Ansible description-file = README.rst author = OpenStack