New doc site layout, 2016.3.0 release note known issue additions

This commit is contained in:
Jacob Hammons 2016-05-25 18:09:37 -06:00
parent d9a96c0e4c
commit 6904936f58
6 changed files with 136 additions and 87 deletions

View file

@ -21,12 +21,12 @@
{% set script_files = [
'_static/js/core.min.js',
'_static/js/webhelp.min_v1.4.3.js',
'_static/js/webhelp.min_v1.4.4.js',
] %}
{% set css_files = [
'_static/css/core.min.css',
'_static/css/webhelp.min_v1.4.4.css',
'_static/css/webhelp.min_v1.4.5.css',
] %}
{%- macro relbar() %}
@ -125,55 +125,79 @@
<![endif]-->
{%- block content %}
<div id="wrapper">
<!--start navbar-->
<nav id="globalNavbar" class="navbar navbar-default navbar-inverse navbar-fixed-top" role="navigation">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbarCollapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="http://saltstack.com/" target="_blank"><img src="{{ pathto('_static/images/saltstack.svg', 1) }}" class="nolightbox" height="40px" width="170px"></a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="navbarCollapse">
<ul class="nav navbar-nav">
<li><a href="/en/latest/">Documentation</a></li>
<li><a href="/en/getstarted/">Tutorials</a></li>
<li><a href="/en/latest/contents.html">Reference Guide</a></li>
<li><a href="https://repo.saltstack.com">Downloads</a></li>
<li><a href="/en/latest/topics/development/">Develop</a></li>
<!--<li><a href="/en/2016.3/faq/">FAQ</a></li>
<li><a href="/en/2016.3/samples/">Code Samples</a></li>-->
<!-- <li><a href="https://repo.saltstack.com" target="_blank">Downloads</a></li>-->
<!--<li><a href="http://saltstack.com/training" target="_blank">Training</a></li>
<li><a href="http://saltstack.com/support" target="_blank">Support</a></li>-->
</ul>
</div>
</div>
</nav>
<!--end navbar-->
<div id="page-content-wrapper">
<div class="container-fluid">
<!--start navbar-->
<div class="row">
<div class="col-sm-12 col-md-11 col-md-offset-1 col-lg-10 col-lg-offset-1">
<!--start navbar-->
<nav class="navbar navbar-default">
<div class="navbar-header">
<button type="button" class="pull-left navbar-toggle collapsed" id="menu-toggle"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<ul id="header-nav" class="nav navbar-nav">
{%- block relbar_small %}{{ relbar() }}{% endblock %}
<nav id="localnav">
<ul class="nav navbar-nav">
{%- block relbar_small %}{{ relbar() }}{% endblock %}
{% if on_saltstack %}
<li><a href="/en/getstarted/" target="_blank">Get Started</a></li>
{% endif %}
{% if not (build_type == "develop" or build_type == "next") and on_saltstack %}
<li><a class="icon-dl" href="/en/pdf/Salt-{{ release }}.pdf"><img height="25" width="25" class="nolightbox" src="{{ pathto('_static/images/pdf_icon.svg', 1) }}"></a></li>
<li><a class="icon-dl" href="/en/epub/Salt-{{ release }}.epub"><img height="25" width="18" class="nolightbox" src="{{ pathto('_static/images/epub_icon.svg', 1) }}"></a></li>
{% endif %}
</ul>
</div>
{% if not (build_type == "develop" or build_type == "next") and on_saltstack %}
<li><a class="icon-dl" href="/en/pdf/Salt-{{ release }}.pdf"><img height="25" width="25" class="nolightbox" src="{{ pathto('_static/images/pdf_icon.svg', 1) }}"></a></li>
<li><a class="icon-dl" href="/en/epub/Salt-{{ release }}.epub"><img height="25" width="18" class="nolightbox" src="{{ pathto('_static/images/epub_icon.svg', 1) }}"></a></li>
{% endif %}
</ul>
</nav>
<!--end navbar-->
</div>
</div>
<!--end navbar-->
<div class="row">
<div class="col-sm-12 col-md-11 col-md-offset-1 col-lg-10 col-lg-offset-1">
{% if "topics/releases" in pagename and "0" in pagename and not release in pagename and not "In Progress" in title %}
<div id="dev-notification">
<div class="alert alert-warning dev-notification-text" role="alert"><i class="glyphicon glyphicon-warning-sign"></i> These release notes are for an old release of Salt. This release might contain known security and other issues that are fixed in the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Release notes for the latest release" href="{{ release }}.html">latest release</a>.</div>
</div>
{% elif build_type == "develop" and on_saltstack %}
<div id="dev-notification">
<div class="alert alert-warning dev-notification-text" role="alert"><i class="glyphicon glyphicon-warning-sign"></i> You are viewing docs from the develop branch, some of these features are not yet released.</div>
</div>
{% elif build_type == "inactive" and on_saltstack %}
<div id="dev-notification">
<div class="alert alert-warning dev-notification-text releaselinks" role="alert"><i class="glyphicon glyphicon-warning-sign"></i> You are viewing docs from a branch that is no longer active. You might want to view docs for the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a> release instead.</div>
</div>
{% endif %}
{% if build_type == "next" and on_saltstack %}
<div id="dev-notification">
<div class="alert alert-warning dev-notification-text" role="alert"><i class="glyphicon glyphicon-warning-sign"></i> You are previewing docs for the next major release, <a target="_blank" data-container="body" data-toggle="tooltip" data-placement="bottom" title="View this branch on GitHub" href="https://github.com/saltstack/salt/tree/{{ next_release_dir }}"> {{ next_release }}.</a></div>
</div>
{% endif %}
{%- block document %}
@ -239,11 +263,15 @@
<div id="sidebar-wrapper">
<div id="sidebar-static">
<a class="ss-logo" href="http://saltstack.com"><img width="250" height="63" class="nolightbox sidebar-logo" src="{{ pathto('_static/images/saltstack_logo.svg', 1) }}"></a>
<!-- <a class="ss-logo" href="http://saltstack.com"><img width="250" height="63" class="nolightbox sidebar-logo" src="{{ pathto('_static/images/saltstack_logo.svg', 1) }}"></a>
{% if on_saltstack %}
{% if [True, False]|random %}
<a href="http://saltconf.com/register" target="_blank"><img class="nolightbox sidebar-banner center" src="{{ pathto('_static/images/banner-saltconf.png', 1) }}"/></a>
{% else %}
<a href="http://saltstack.com/support" target="_blank"><img class="nolightbox sidebar-banner center" src="{{ pathto('_static/images/banner-support.png', 1) }}"/></a>
{% endif %}-->
{% if build_type=="next" %}
@ -292,8 +320,8 @@
</div>
<div id="sidebar-static-bottom">
<div class="text-nowrap">
<!--social icons from http://vervex.deviantart.com/art/somacro-45-300dpi-social-media-icons-267955425-->
<!--<div class="text-nowrap">
&lt;!&ndash;social icons from http://vervex.deviantart.com/art/somacro-45-300dpi-social-media-icons-267955425&ndash;&gt;
<ul id="social-links" class="list-inline">
<li><a data-container="body" data-delay='{ "show": 500, "hide": 100 }' data-toggle="tooltip" data-placement="top" title="watch saltstack videos on youtube" href="https://www.youtube.com/user/saltstack" target="_blank"><img class="nolightbox" width="24" src="{{ pathto('_static/images/youtube-variation.png', 1) }}" ></a></li>
<li><a data-container="body" data-delay='{ "show": 500, "hide": 100 }' data-toggle="tooltip" data-placement="top" title="view the latest saltstack tweets" href="http://twitter.com/saltstackinc" target="_blank"><img class="nolightbox" width="24" src="{{ pathto('_static/images/twitter.png', 1) }}" ></a></li>
@ -305,7 +333,7 @@
<li><a data-container="body" data-delay='{ "show": 500, "hide": 100 }' data-toggle="tooltip" data-placement="top" title="join or start a saltstack meetup" href="http://www.meetup.com/find/?keywords=saltstack" target="_blank"><img class="nolightbox" width="24" src="{{ pathto('_static/images/meetup.png', 1) }}" ></a></li>
<li><a data-container="body" data-delay='{ "show": 500, "hide": 100 }' data-toggle="tooltip" data-placement="top" title="follow saltstack on linkedin" href="http://www.linkedin.com/company/salt-stack-inc" target="_blank"><img class="nolightbox" width="24" src="{{ pathto('_static/images/linkedin.png', 1) }}" ></a></li>
</ul>
</div>
</div>-->
</div>
</div>
<!--end sidebar-->

View file

@ -6,7 +6,6 @@ blockquote{font-size:15px}
button#dropdownMenu1{width:90%;padding:10px;margin:10px}
.panel-default>.panel-heading{background-color:#f8f8f2;border:1px solid #e3e3e3}
.well{background-color:#f5f5f5;border:1px solid #e3e3e3}
.nav>li>a{position:relative;display:block;padding:0}
#guide-links a,#guide-title{text-transform:uppercase;font-weight:300}
#guide-title,.well-title{text-transform:uppercase;font-weight:300}
.body-content img{max-width:100%;width:auto\9;height:auto;vertical-align:middle;border:0;-ms-interpolation-mode:bicubic}
@ -46,19 +45,19 @@ button#prev-button{float:left;margin:15px 0 0}
#search-form{padding:5px 5px 10px}
#wrapper{padding-left:0;-webkit-transition:all .5s ease;-moz-transition:all .5s ease;-o-transition:all .5s ease;transition:all .5s ease}
#wrapper.toggled{padding-left:250px}
#sidebar-wrapper{z-index:1000;position:fixed;top:0;right:260px;width:0;height:100%;margin-right:-250px;overflow-y:hidden;overflow-x:hidden;-webkit-transition:all .5s ease;-moz-transition:all .5s ease;-o-transition:all .5s ease;transition:all .5s ease;background-color:#fff}
#sidebar-wrapper{z-index:1000;position:fixed;top:0;right:260px;width:0;height:100%;margin-right:-250px;padding-top:60px;overflow-y:hidden;overflow-x:hidden;-webkit-transition:all .5s ease;-moz-transition:all .5s ease;-o-transition:all .5s ease;transition:all .5s ease;background-color:#fff}
#sidebar-nav{position:absolute;top:0;width:260px;font-size:14px}
#wrapper.toggled #sidebar-wrapper{width:260px}
#page-content-wrapper{width:95%;padding:15px;font-size:15px;line-height:1.7}
#wrapper.toggled #page-content-wrapper{position:absolute;margin-left:-250px}
#dev-notification{position:fixed;top:0;left:0;width:100%;background-color:#fff;text-align:center;z-index:20}
.alert.alert-warning.dev-notification-text{padding:0;margin-bottom:0;width:95%}
/*#dev-notification{}*/
.alert.alert-warning.dev-notification-text{position:fixed;bottom:0;left:0;width:100%;text-align:center;z-index:20;padding:0;margin-bottom:0;width:95%}
@media(min-width:768px) {
#wrapper{padding-right:260px}
#wrapper.toggled{padding-right:0}
#sidebar-wrapper{width:260px}
#wrapper.toggled #sidebar-wrapper{width:0}
#page-content-wrapper{padding:20px 0 0}
#page-content-wrapper{padding:70px 0 0}
#wrapper.toggled #page-content-wrapper{position:relative;margin-right:0}
#menu-toggle{display:none!important}
.alert.alert-warning.dev-notification-text{width:65%}
@ -69,7 +68,7 @@ button#prev-button{float:left;margin:15px 0 0}
#sidebar-wrapper{width:300px}
#sidebar-nav{width:300px}
#wrapper.toggled #sidebar-wrapper{width:0}
#page-content-wrapper{padding:20px 0 0}
#page-content-wrapper{padding:70px 0 0}
#wrapper.toggled #page-content-wrapper{position:relative;margin-right:0}
#menu-toggle{display:none!important}
.footer-banner{width:90%}
@ -81,7 +80,7 @@ button#prev-button{float:left;margin:15px 0 0}
#sidebar-wrapper{width:350px}
#sidebar-nav{width:300px}
#wrapper.toggled #sidebar-wrapper{width:0}
#page-content-wrapper{padding:20px 0 0}
#page-content-wrapper{padding:70px 0 0}
#wrapper.toggled #page-content-wrapper{position:relative;margin-right:0}
#menu-toggle{display:none!important}
.alert.alert-warning.dev-notification-text{width:68%}
@ -148,8 +147,6 @@ ul.nav.collapsed{margin-left:80px;font-size:14pt}
#expanded-nav li{padding:0 15px 0 0}
ul.nav.collapsed li{padding:0 0 15px 10px;margin:0}
#social-links{text-align:center;padding:15px 0}
.navbar-default{background-color:#fff;border-color:#fff}
.navbar-header{width:100%}
.open>.dropdown-menu{width:100%}
#lnav-title{font-weight:300;font-size:16pt;text-align:center}
pre{border-top-width:4px;padding-top:18px}
@ -179,6 +176,48 @@ div.versions a,div.versions a:hover,div.versions a:active{color: #428bca}
.sidebar-banner{padding: 0 0 10px 0}
.sidebar-logo{display:block;margin: 10px auto 10px auto}
.navbar-inverse .navbar-nav>li>a {
color: #9d9d9d;
}
@media (min-width: 768px)
.navbar-nav>li>a {
padding-top: 15px;
padding-bottom: 15px;
}
.navbar-nav>li>a {
padding-top: 10px;
padding-bottom: 10px;
line-height: 20px;
}
.nav>li>a {
position: relative;
display: block;
padding: 15px 15px;
font-weight: 300;
line-height: 20px;
font-size: 16px;
}
#localnav {
float: right;
}
#localnav li>a {
padding: 20px 15px 10px 20px;
float: right;
font-size: 14px;
}
.navbar-header img {
margin-top: 5px;
margin-right: 15px;
}
.navbar-nav {
float: right;
}
/*pygments*/
.highlight .hll { background-color: #ffffcc }

View file

@ -0,0 +1 @@
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 251.6 58.99"><defs><style>.cls-1{fill:#fff;}</style></defs><title>SaltStack - White</title><path class="cls-1" d="M162.94,30.48c-4.21-1-4.67-1.68-4.67-2.93s1.2-2,3-2a9.15,9.15,0,0,1,5.49,2.09l0.41,0.31,2.58-3.64L169.36,24a12.39,12.39,0,0,0-8-2.8c-4.59,0-7.79,2.75-7.79,6.75,0,4.22,2.75,5.71,7.49,6.85,4.12,1,4.43,1.72,4.43,2.84,0,1.32-1.29,2.18-3.28,2.18a9.26,9.26,0,0,1-6.41-2.65l-0.38-.33-2.89,3.43,0.36,0.32a13.65,13.65,0,0,0,9.24,3.54c4.93,0,8.11-2.7,8.11-6.94S166.7,31.4,162.94,30.48Z" transform="translate(-4.23 -4.49)"/><polygon class="cls-1" points="185.7 17.02 167.4 17.02 167.4 21.49 174.16 21.49 174.16 39.35 178.94 39.35 178.94 21.49 185.7 21.49 185.7 17.02"/><path class="cls-1" d="M197.88,21.36l-9.82,22.49H193l2.19-5.15h6l1.58-4.21,4,9.36h5.06L202,21.36h-4.13Zm-0.89,13,2.9-6.76,2.87,6.76H197Z" transform="translate(-4.23 -4.49)"/><path class="cls-1" d="M229.24,37.12c-1.75,1.63-3.32,2.64-5.79,2.64-3.73,0-6.54-3-6.54-7.15s2.81-7,6.54-7a7.94,7.94,0,0,1,5.63,2.52l0.38,0.35,3.07-3.52-0.35-.33a11.58,11.58,0,0,0-8.7-3.46A11.28,11.28,0,0,0,212,32.74a11.29,11.29,0,0,0,11.36,11.47,11.55,11.55,0,0,0,9-3.93l0.34-.35-3.09-3.14Z" transform="translate(-4.23 -4.49)"/><polygon class="cls-1" points="241.98 26.73 251.36 17.02 245.37 17.02 235.93 26.99 235.93 17.02 231.18 17.02 231.18 39.35 235.93 39.35 235.93 32.87 238.71 30.02 245.8 39.35 251.6 39.35 241.98 26.73"/><path class="cls-1" d="M84,31c-5-1.07-5.4-2.24-5.4-3.72,0-1.73,1.66-2.94,4-2.94a8.89,8.89,0,0,1,5.84,2.2l0.4,0.33,2-2.66-0.38-.3a11.59,11.59,0,0,0-7.82-2.73c-4.35,0-7.5,2.66-7.5,6.39,0,4.16,3,5.66,7.55,6.65,4.77,1,5.15,2.16,5.15,3.63,0,1.87-1.71,3.13-4.25,3.13a9.64,9.64,0,0,1-7-2.89l-0.38-.35-2.14,2.53,0.36,0.32a12.9,12.9,0,0,0,9.06,3.54c4.58,0,7.78-2.69,7.78-6.59C91.37,34.1,89.17,32.15,84,31Z" transform="translate(-4.23 -4.49)"/><path class="cls-1" d="M102.89,21.36L92.72,43.84h3.57l2.54-5.64h8.61l1.06-2.89,3.78,8.53H116L105.8,21.36h-2.91ZM100.21,35l4.1-9.15L108.37,35h-8.16Z" transform="translate(-4.23 -4.49)"/><polygon class="cls-1" points="118.08 17.02 114.67 17.02 114.67 39.35 130.09 39.35 130.09 36.13 118.08 36.13 118.08 17.02"/><polygon class="cls-1" points="128.97 20.24 136.13 20.24 136.13 39.35 139.56 39.35 139.56 20.24 146.73 20.24 146.73 17.02 128.97 17.02 128.97 20.24"/><path class="cls-1" d="M64.26,13.35L48.92,4.49,38.08,10.75l-8.86-5-25,14.43V49l25,14.43L54.22,49V36.85l10-5.8V13.35ZM60,14.17l-11,6.38-11-6.38,11-6.38ZM31.81,20.93l1.78-1v2l-0.74-.43h0Zm4.64-4.28,11,6.38V35.74l-5.13-3.06V27l-5.92-3.42v-7ZM42.36,36l4,2.39-4,2.31V36ZM29.23,8.71l6.27,3.53-1.92,1.11V17l-6.94,3.93,3.43,2,8.45,4.88-9.3,5.37L8.07,20.92ZM6.79,23.14L27.95,35.35V59.78L6.79,47.57V23.14ZM51.66,47.57L30.51,59.78V35.35L39.8,30V45.15l9.08-5.24h0l2.75-1.59v9.23ZM50.35,35.78V23l11-6.38V29.4Z" transform="translate(-4.23 -4.49)"/></svg>

After

Width:  |  Height:  |  Size: 2.8 KiB

View file

@ -26,7 +26,8 @@ $( document ).ready(function() {
}
/*scroll the right-hand navigation*/
var wheight = $( window ).height() - $( '#sidebar-static' ).height() - $( '#sidebar-static-bottom' ).height();
//var wheight = $( window ).height() - $( '#sidebar-static' ).height() - $( '#sidebar-static-bottom' ).height();
var wheight = $( window ).height() - 160;
$(function(){
$( '#sidebar-nav' ).slimScroll({
width: 'inherit',
@ -38,16 +39,16 @@ $( document ).ready(function() {
var hash = window.location.hash.substring(1);
var $link = $( '#sidebar-nav').find('a[href$="#' + hash + '"]').addClass("selected");
if ($link.length) {
var scrollTo_val = $link.offset().top - ($( '#sidebar-static' ).height() + 40) + 'px';
var scrollTo_val = $link.offset().top - ($( '#sidebar-static' ).height() + 200) + 'px';
$( '#sidebar-nav' ).slimScroll({ scrollTo : scrollTo_val });
}
else if ($( 'a.current' ).length) {
var scrollTo_val = $( 'a.current' ).offset().top - ($( '#sidebar-static' ).height() + 40) + 'px';
var scrollTo_val = $( 'a.current' ).offset().top - ($( '#sidebar-static' ).height() + 200) + 'px';
$( '#sidebar-nav' ).slimScroll({ scrollTo : scrollTo_val });
}
}
else if ($( 'a.current' ).length) {
var scrollTo_val = $( 'a.current' ).offset().top - ($( '#sidebar-static' ).height() + 40) + 'px';
var scrollTo_val = $( 'a.current' ).offset().top - ($( '#sidebar-static' ).height() + 200) + 'px';
$( '#sidebar-nav' ).slimScroll({ scrollTo : scrollTo_val });
}
/*hidden by css - make visible after slimScroll plug-in loads*/

View file

@ -211,18 +211,16 @@ project = 'Salt'
copyright = '2016 SaltStack, Inc.'
version = salt.version.__version__
latest_release = '2015.8.10' # latest release
previous_release = '2015.5.10' # latest release from previous branch
previous_release_dir = '2015.5' # path on web server for previous branch
next_release = '2016.3.0' # latest release from previous branch
next_release_dir = '2016.3' # path on web server for previous branch
latest_release = '2016.3.0' # latest release
previous_release = '2015.8.10' # latest release from previous branch
previous_release_dir = '2015.8' # path on web server for previous branch
next_release = '' # next release
next_release_dir = '' # path on web server for next release branch
# < --- START do not merge these settings to other branches START ---> #
build_type = 'develop' # latest, previous, develop, next
# set release to 'version' for develop so sha is used
# - otherwise -
# set release to 'latest_release' or 'previous_release'
release = latest_release # version, latest_release, previous_release
release = version # version, latest_release, previous_release
# < --- END do not merge these settings to other branches END ---> #
# Set google custom search engine
@ -232,6 +230,8 @@ elif release.startswith('2014.7'):
search_cx = '004624818632696854117:thhslradbru' # 2014.7
elif release.startswith('2015.5'):
search_cx = '004624818632696854117:ovogwef29do' # 2015.5
elif release.startswith('2015.8'):
search_cx = '004624818632696854117:aw_tegffouy' # 2015.8
else:
search_cx = '004624818632696854117:haj7bjntf4s' # develop

View file

@ -4,6 +4,13 @@
Salt 2016.3.0 Release Notes - Codename Boron
============================================
Known Issues
============
- :issue:`33516`: When upgrading from 2015.8.10 to 2016.3.0 on centos7/redhat7
salt-minion must be restarted twice.
- :issue:`33517`: SPM does not work on amazon linux 2015 in 2016.3.0.
Backwards-incompatible Changes
==============================
@ -193,33 +200,6 @@ syndic fixes alone can cause minor performance issues with older master of maste
Please update masters first, then syndics.
Minions do not need to be updated for this fix to work.
RunnerClient Changes
====================
Deprecation warning:
Salt's ``RunnerClient`` class now accepts ``arg`` and ``kwarg`` (singular)
instead of the plural form args and kwargs in the low data. Passing plural forms for args
and kwargs will throw a ``RuntimeException`` for Salt Oxygen (and subsequent releases).
Until Salt Oxygen args and kwargs will also be accepted along with arg and kwarg.
An example of the new low data:
.. code-block:: python
opts = salt.config.master_config('/etc/salt/master')
client = salt.runner.RunnerClient(opts)
client.cmd_sync({
'fun': 'test.arg',
'client': 'runner',
'arg': ['an', 'argument', 'list'],
'kwarg': {'key': 'value'},
})
The above example will also work with ``args`` and ``kwargs``
until the ``Salt Oxygen`` release.
Module Changes
==============
@ -321,7 +301,7 @@ Windows DSC Integration (Experiemental)
Dimension Data Cloud Support
----------------------------
A SaltStack Cloud driver for `Dimension Data Public Cloud`_, provides the driver functionality to service automation for any of the Dimension
A SaltStack Cloud driver for `Dimension Data Public Cloud`_, provides the driver functionality to service automation for any of the Dimension
Data Public Cloud locations:
- Deploy new virtual machines