diff --git a/FORMULA b/FORMULA index 67aeabd..99da00c 100644 --- a/FORMULA +++ b/FORMULA @@ -1,9 +1,9 @@ name: sysstat -os: FreeBSD -os_family: FreeBSD -version: 1.1.0 +os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, Solaris, SmartOS +os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD, Solaris +version: 1.0.0 release: 1 minimum_version: 2016.11 summary: sysstat formula -description: Formula to set up sysstat +description: Formula to install sysstat/sar and configure it. top_level_dir: sysstat diff --git a/docs/AUTHORS.rst b/docs/AUTHORS.rst deleted file mode 100644 index e69de29..0000000 diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst deleted file mode 100644 index e69de29..0000000 diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 50f36f6..b7da8f4 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -154,36 +154,6 @@ An example of that: ... BREAKING CHANGE: With the removal of all of the `.sls` files under - `sysstat package`, this formula no longer supports the installation of + `template package`, this formula no longer supports the installation of packages. - -Semantic release formulas -------------------------- - -These formulas are already compatible with semantic-release: - -* `bind-formula `_ -* `cert-formula `_ -* `chrony-formula `_ -* `collectd-formula `_ -* `fail2ban-formula `_ -* `keepalived-formula `_ -* `nginx-formula `_ -* `postfix-formula `_ -* `postgres-formula `_ -* `prometheus-formula `_ -* `rkhunter-formula `_ -* `salt-formula `_ -* `sudoers-formula `_ -* `syslog-ng-formula `_ -* `systemd-formula `_ -* `sysstat-formula `_ -* `ufw-formula `_ -* `vault-formula `_ - - -Documentation -------------- - -`Documentation contributing guidelines `_ diff --git a/docs/CONTRIBUTING_DOCS.rst b/docs/CONTRIBUTING_DOCS.rst deleted file mode 100644 index 5b59b29..0000000 --- a/docs/CONTRIBUTING_DOCS.rst +++ /dev/null @@ -1,96 +0,0 @@ -.. _contributing_docs: - -Contributing documentation -========================== - -|docs| - -.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest - :alt: Documentation Status - :scale: 100% - :target: https://template-formula.readthedocs.io/en/latest/?badge=latest - -Toolchain -^^^^^^^^^ - -The documentation for this formula is written in -`reStructuredText `_ -(also known as RST, ReST, or reST). -It is built by -`Sphinx `_ -and hosted on -`Read the Docs `_. - -Adding a new page -^^^^^^^^^^^^^^^^^ - -Adding a new page involves two steps: - -#. Use the - :ref:`provided page template ` - to create a new page. -#. Add the page name under the ``toctree`` list in ``index.rst``. - - a. Do not just append it to the list. - #. Select the best place where it fits within the overall documentation. - -SaltStack-Formulas' RST page template -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _saltstack_formulas_rst_page_template - -Use the following template when creating a new page. -This ensures consistency across the documentation for this formula. -The heading symbols have been selected in accordance to the output rendered by the -`Markdown to reStructuredText converter `_ -we are using for some of the pages of this documentation. - -.. code-block:: rst - - .. _template: - - [Page title] - ============ - - [Introductory paragraph] - - .. contents:: **Table of Contents** - - [Heading 2] - ----------- - - [Heading 3] - ^^^^^^^^^^^ - - [Heading 4] - ~~~~~~~~~~~ - - [Heading 5] - """"""""""" - - [Heading 6] - ########### - -#. The first line is an anchor that can be used to link back to (the top of) - this file. - - a. Change this to be the lowercase version of the file name. - #. Do not include the ``.rst`` file extension. - #. Use hyphens (``-``) instead of spaces or non-letter characters. - -#. Change the ``[Page title]`` accordingly, matching the same number of equals - signs (``=``) underneath. -#. Change the ``[Introductory paragraph]`` to be a short summary of the page - content. - Use no more than three paragraphs for this. -#. Leave the ``..contents:: **Table of Contents**`` line as it is. -#. Use the remaining headings as required to break up the page content. - - a. You will rarely need to use beyond ``[Heading 4]``. - #. Again, no single heading should have more than about three paragraphs of - content before the next heading or sub-heading is used. - -Obviously, it is not necessary to follow the steps in the order above. -For example, it is usually easier to write the ``[Introductory paragraph]`` -at the end. - diff --git a/docs/README.rst b/docs/README.rst index 6f0f61f..8057d43 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,7 +1,7 @@ .. _readme: sysstat-formula -================ +=============== |img_travis| |img_sr| @@ -14,8 +14,7 @@ sysstat-formula :scale: 100% :target: https://github.com/semantic-release/semantic-release -A SaltStack formula that is empty. It has dummy content to help with a quick -start on a new formula and it serves as a style guide. +Formula to install sysstat/sar and configure it. .. contents:: **Table of Contents** @@ -47,7 +46,7 @@ Available states :local: ``sysstat`` -^^^^^^^^^^^^ +^^^^^^^^^^^ *Meta-state (This is a state that includes other states)*. @@ -56,29 +55,29 @@ manages the sysstat configuration file and then starts the associated sysstat service. ``sysstat.package`` -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ This state will install the sysstat package only. ``sysstat.source`` -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ This state will install the sysstat from source only. ``sysstat.config`` -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ This state will configure the sysstat service and has a dependency on ``sysstat.install`` via include list. ``sysstat.service`` -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ This state will start the sysstat service and has a dependency on ``sysstat.config`` via include list. ``sysstat.clean`` -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^ *Meta-state (This is a state that includes other states)*. @@ -88,18 +87,18 @@ removes the configuration file and then uninstalls the package. ``sysstat.service.clean`` -^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^ This state will stop the sysstat service and disable it at boot time. ``sysstat.config.clean`` -^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^ This state will remove the configuration of the sysstat service and has a dependency on ``sysstat.service.clean`` via include list. ``sysstat.package.clean`` -^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^ This state will remove the sysstat package and has a depency on diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css deleted file mode 100644 index 4617efc..0000000 --- a/docs/_static/css/custom.css +++ /dev/null @@ -1,21 +0,0 @@ -/* - Override styles for in-use Sphinx theme -*/ - -/* The next two `.wy`-based rules are specifically needed for the dealing with */ -/* the `sphinx_rtd_theme` bug where long lines do not wrap in tables */ - -/* override table width restrictions */ -.wy-table-responsive table th -, .wy-table-responsive table td -{ - /* !important prevents the common CSS stylesheets from - overriding this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; -} - -.wy-table-responsive -{ - overflow: visible !important; -} - diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index afc8bd3..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,173 +0,0 @@ -# -*- coding: utf-8 -*- -"""Configuration file for the Sphinx documentation builder. - -This file does only contain a selection of the most common options. For a -full list see the documentation: - -* http://www.sphinx-doc.org/en/stable/config - -""" - -from __future__ import division, print_function, unicode_literals - -# from datetime import datetime - -from recommonmark.parser import CommonMarkParser - -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . -__author__ = 'Imran Iqbal' # noqa: E221 -__copyright__ = 'Copyright (C) 2019, MYII' # noqa: E221 -__license__ = 'Apache-2.0' # noqa: E221 -__version__ = 'latest' # noqa: E221 -__maintainer__ = 'Imran Iqbal' # noqa: E221 - - -# -- Project information ----------------------------------------------------- - -project = 'template-formula' -copyright = __copyright__.replace('Copyright (C) ', '') # noqa: A001 -author = __author__ -version = __version__ -release = __version__ - - -# -- General configuration --------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['templates', '_templates', '.templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -source_suffix = ['.rst', '.md'] - -# The master toctree document. -master_doc = 'index' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path . -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - - -# -- Options for the reStructuredText parser --------------------------------- - -file_insertion_enabled = False - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'template-formula' - - -# -- Options for Markdown output --------------------------------------------- - -source_parsers = { - '.md': CommonMarkParser, -} - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - 'index', - 'template-formula.tex', - u'template-formula Documentation', - u'', - 'manual', - ), -] - - -# -- Functions: `setup`, docstring preprocessing, etc. ----------------------- - -def setup(app): - """Prepare the Sphinx application object. - - Used for providing a custom CSS file for override styles. - - Parameters - ---------- - app : object - The Sphinx application object. - - Returns - ------- - app : object - The Sphinx application object. - - """ - app.add_stylesheet('css/custom.css') - return app diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index f4d7816..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _index: - -.. ``template-formula`` documentation master file. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to template-formula's documentation! -============================================ - -.. toctree:: - :maxdepth: 1 - :caption: Contents - :numbered: - :glob: - - README - CONTRIBUTING - TOFS_pattern - AUTHORS - CHANGELOG