Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix incremental doc builds - OS X, postgres returner, tcp transport doc updates #35865

Merged
merged 2 commits into from
Aug 31, 2016
Merged

Fix incremental doc builds - OS X, postgres returner, tcp transport doc updates #35865

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c327713
Updates doc builds to generate build timestamp only when building for…
jacobhammons Aug 29, 2016
ae45fe2
Generate copyright date
jacobhammons Aug 30, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/_themes/saltstack2/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@

{% if on_saltstack %}
<div class="col-sm-6">
<p><i>Generated on {{today}}.</i></p>
<p><i>{{today}}</i></p>

{% if build_type == "latest" %}
<p>You are viewing docs for the latest stable release, {{ latest_release }}. Switch to docs for the previous stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
Expand Down
10 changes: 6 additions & 4 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,9 @@ def inner(fn, *iargs, **ikwargs):

# -- General Configuration -----------------------------------------------------

# Set a var if we're building docs for the live site or not
on_saltstack = 'SALT_ON_SALTSTACK' in os.environ

project = 'Salt'
copyright = '2016 SaltStack, Inc.'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice if we could dynamically update the year using the same technique as we do for the today variable below.


Expand All @@ -217,7 +220,9 @@ def inner(fn, *iargs, **ikwargs):
next_release = '' # next release
next_release_dir = '' # path on web server for next release branch

today = time.strftime("%B %d, %Y") + " at " + time.strftime("%X %Z")
today = ''
if on_saltstack:
today = "Generated on " + time.strftime("%B %d, %Y") + " at " + time.strftime("%X %Z") + "."

# < --- START do not merge these settings to other branches START ---> #
build_type = 'latest' # latest, previous, develop, next
Expand Down Expand Up @@ -321,9 +326,6 @@ def inner(fn, *iargs, **ikwargs):
html_favicon = 'favicon.ico'
html_use_smartypants = False

# Set a var if we're building docs for the live site or not
on_saltstack = 'SALT_ON_SALTSTACK' in os.environ

# Use Google customized search or use Sphinx built-in JavaScript search
if on_saltstack:
html_search_template = 'googlesearch.html'
Expand Down
3 changes: 3 additions & 0 deletions doc/topics/installation/osx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ When only using the OS X system's pip, install this way:

Salt-Master Customizations
==========================
.. note::
Salt master on OS X is not tested or supported by SaltStack. See `SaltStack Platform Support <https://saltstack.com/product-support-lifecycle/>`_ for more information.

To run salt-master on OS X, sudo add this configuration option to the /etc/salt/master file:

.. code-block:: bash
Expand Down
8 changes: 7 additions & 1 deletion doc/topics/transports/tcp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@
TCP Transport
=============

The "tcp" transport is an implementation of Salt's channels using raw tcp sockets.
The tcp transport is an implementation of Salt's channels using raw tcp sockets.
Since this isn't using a pre-defined messaging library we will describe the wire
protocol, message semantics, etc. in this document.

The tcp transport is enabled by changing the :conf_minion:`transport` setting
to ``tcp`` on each Salt minion and Salt master.

.. code-block:: yaml

transport: tcp

Wire Protocol
=============
Expand Down
7 changes: 7 additions & 0 deletions salt/returners/postgres.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
'''
Return data to a postgresql server

.. note::
:mod:`returners.postgres_local_cache <salt.returners.postgres_local_cache>`
is recommended instead of this module when using PostgreSQL as a
:ref:`master job cache <external-master-cache>`. These two modules
provide different functionality so you should compare each to see which
module best suits your particular needs.

:maintainer: None
:maturity: New
:depends: psycopg2
Expand Down
7 changes: 7 additions & 0 deletions salt/returners/postgres_local_cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
Use a postgresql server for the master job cache. This helps the job cache to
cope with scale.

.. note::
:mod:`returners.postgres <salt.returners.postgres>` is also available if
you are not using PostgreSQL as a :ref:`master job cache
<external-master-cache>`. These two modules provide different
functionality so you should compare each to see which module best suits
your particular needs.

:maintainer: gjredelinghuys@gmail.com
:maturity: New
:depends: psycopg2
Expand Down