openstack
/
fuel-docs
Code Issues Proposed changes

update design 

Change-Id: I350467f3fc0776b927319e63998a583fbb6e2043
This commit is contained in:
Jim Phillips 2015-11-11 10:37:01 -05:00 committed by Jim Phillips
parent 119eb9f7c6
commit 0eace58ae2
19 changed files with 1113 additions and 2387 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
_static/mirantis_logo.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.3 KiB

After

Width:  |  Height:  |  Size: 9.3 KiB

161
_templates/layout.html
View File

@ -6,141 +6,10 @@
{% block footer %}
<footer>
<section class="fsprod">
<div class="container">
<div class="row">
<div class="col-md-6">
<ul style="margin-bottom:0;">
<li><a class="fmenu_section" href="https://www.mirantis.com/products/mirantis-openstack-software/"
style="margin-top: 15px;">Products</a></li>
</ul>
<div class="row">
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/mirantis-openstack-software/"
class="fproduct">
<div class="footerglyph1"></div>
<span>Mirantis <br>OpenStack Software</span></a></div>
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/application-catalog-murano/"
class="fproduct">
<div class="footerglyph2"></div>
<span>Application <br>Catalog Murano</span></a></div>
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/openstack-drivers-and-plugins/"
class="fproduct">
<div class="footerglyph3"></div>
<span>OpenStack Drivers <br>and Plugins</span></a></div>
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/unlocked-appliances/" class="fproduct">
<div class="footerglyph4"></div>
<span>Unlocked <br>Appliances</span></a></div>
</div>
</div>
<hr class="hidden-lg hidden-md">
<div class="col-md-3 col-sm-6 col-xs-6 hidden-sm hidden-xs ">
<ul>
<li><a class="fmenu_section" style="margin-top: 15px;">Solutions</a></li>
<li><a href="https://www.mirantis.com/solutions/dev-test/">Dev/Test</a></li>
<li><a href="https://www.mirantis.com/solutions/platform-as_a_service_paas/">PaaS</a></li>
<li><a href="https://www.mirantis.com/solutions/container-technologies/">Containers</a></li>
<li><a href="https://www.mirantis.com/solutions/network-functions-virtualization-nfv/">NFV</a></li>
<li><a href="https://www.mirantis.com/solutions/hybrid-cloud/">Hybrid Cloud</a></li>
<li><a href="https://www.mirantis.com/solutions/industry-solutions/">Industry Solutions</a></li>
</ul>
</div>
<div class="col-md-3 col-sm-6 col-xs-6">
<ul>
<li><a class="fmenu_section" style="margin-top: 15px;">Support</a></li>
<li><a href="https://www.mirantis.com/support/enterprise-support-services/">Enterprise Support</a></li>
<li><a href="https://www.mirantis.com/products/mirantis-openstack-software/">Download and
Install</a></li>
<li><a href="https://www.mirantis.com/products/mirantis-openstack-software/documentation/">Documentation</a></li>
<li><a href="https://ask.openstack.org/">Community</a>
</li>
<li><a href="https://software.mirantis.com/mirantis-openstack-technical-bulletins/">Product Updates</a>
</li>
</ul>
</div>
<div class="hidden-lg hidden-md col-sm-6 col-xs-6">
<ul>
<li><a class="fmenu_section" href="https://www.mirantis.com/company/about-pure-play-openstack/"
style="margin-top: 15px;">Company</a></li>
<li><a href="https://online.mirantis.com/contact-us">Get In Touch</a></li>
<li><a href="https://www.mirantis.com/contact/">Locations</a></li>
<li><a href="https://www.mirantis.com/careers/">Careers</a></li>
<li><a href="https://www.mirantis.com/company/leadership/">Management</a></li>
<li><a href="https://www.mirantis.com/company/investors/">Investors</a></li>
<li><a href="https://www.mirantis.com/company/leadership/board-of-directors/">Board of Directors</a></li>
<li><a href="https://www.mirantis.com/company/press-center/info/">Press Center</a></li>
</ul>
</div>
</div>
<hr class="hidden-lg hidden-md hidden-sm hidden-xs">
</div>
</section>
<section class="fscomp">
<div class="container footsm hidden-sm hidden-xs">
<div class="row">
<div class="col-md-2">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">Services</a></li>
<li><a href="https://www.mirantis.com/services/managed-services/">Managed Services</a></li>
<li><a href="https://www.mirantis.com/services/assessment/">Assessment</a></li>
<li><a href="https://www.mirantis.com/services/implementation/">Implementation</a></li>
<li><a href="https://www.mirantis.com/services/enterprise-support-services/">Enterprise Support</a></li>
<li><a href="https://www.mirantis.com/services/migration-services/">Migration Services</a></li>
<li><a href="https://www.mirantis.com/services/drivers-upstreaming-maintenance/">Driver Development</a></li>
</ul>
</div>
<div class="col-md-2 hidden-sm">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">Training</a></li>
<li><a href="https://training.mirantis.com/openstack-courses">OpenStack Courses</a></li>
<li><a href="https://training.mirantis.com/certification">Certification</a></li>
<li><a href="https://training.mirantis.com/online-virtual-training">Virtual Training</a></li>
<li><a href="https://training.mirantis.com/training/onsite.html">OnSite Training</a></li>
<li><a href="https://training.mirantis.com/online-resources">Training Resources</a></li>
</ul>
</div>
<div class="col-md-2 hidden-sm">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">Partners</a></li>
<li><a href="https://www.mirantis.com/partners/">Overview</a></li>
<li><a href="https://www.mirantis.com/partners/mirantis-unlocked-partner-solutions/">Partner list</a></li>
<li><a href="https://www.mirantis.com/partners/mirantis-channel-partners/">Channel Partners</a></li>
<li><a href="https://www.mirantis.com/partners/service-providers/">Service Providers</a></li>
<li><a href="https://training.mirantis.com/mirantis-training-partner-program-intro/">Training
Partners</a></li>
<li><a href="https://www.mirantis.com/partners/become-mirantis-technology-partner/">Become a Partner</a></li>
</ul>
</div>
<div class="col-md-3 hidden-sm">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">OpenStack Now</a></li>
<li><a href="https://www.mirantis.com/blog/">Blog</a></li>
<li><a href="https://www.mirantis.com/openstack/">News</a></li>
<li><a href="https://www.mirantis.com/openstack/tutorials/">Tutorials</a></li>
<li><a href="https://www.mirantis.com/openstack/news/community-news/">Community/Events</a></li>
<li><a href="http://online.mirantis.com/openstack-now-newsletter/">Subscribe</a></li>
</ul>
</div>
<div class="col-md-3 hidden-sm">
<ul>
<li><a class="fmenu_section" href="https://www.mirantis.com/company/about-pure-play-openstack/"
style="font-weight:normal;">Company</a></li>
<li><a href="https://online.mirantis.com/contact-us">Get In Touch</a></li>
<li><a href="https://www.mirantis.com/contact/">Locations</a></li>
<li><a href="https://www.mirantis.com/careers/">Careers</a></li>
<li><a href="https://www.mirantis.com/company/leadership/">Management</a></li>
<li><a href="https://www.mirantis.com/company/investors/">Investors</a></li>
<li><a href="https://www.mirantis.com/company/leadership/board-of-directors/">Board of Directors</a></li>
<li><a href="https://www.mirantis.com/company/press-center/info/">Press Center</a></li>
</ul>
</div>
</div>
</div>
</section>
<div class="clear"></div>
<div class="footer_copy">
<div class="container">
<div class="row">
<div class="col-md-3 col-sm-3 col-logo text-left-lg text-left-md text-left-sm text-center-xs">
<div class="col-md-4 col-sm-3 col-logo text-left-lg text-left-md text-left-sm text-center-xs">
<span class="mira_btm">Mirantis Inc.</span> <br>
<span class="pureplay_btm">Pure Play OpenStack.</span>
</div>
@ -148,27 +17,15 @@
<span class="copy_btm">&copy; 2005 &mdash; 2015 Mirantis, Inc.<br><span
style="font-size: 10px; opacity:0.6; line-height: 0.9em; display:inline-block;margin-top:5px; ">All rights reserved. "Mirantis" and "FUEL" are are registered trademarks of Mirantis, Inc. All other trademarks are the property of their respective owners.</span></span>
</div>
<div class="col-md-5 col-sm-4 col-address text-right-lg text-right-md text-right-sm text-center-xs">
<div class="col-md-4 col-sm-4 col-address text-right-lg text-right-md text-right-sm text-center-xs">
<span class="mira_btm">525 Almanor Ave, 4th Floor - Sunnyvale, CA 94085<br>
+1-650-963-9828</span>
</div>
</div>
<div class="row">
<div class="col-md-3 col-sm-3 col-logo">
</div>
<div class="col-md-4 col-sm-4 cc">
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/3.0/88x31.png"></a><br>This work is
licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative
Commons Attribution-ShareAlike 3.0 Unported License</a>.
</div>
</div>
</div>
</div>
</footer>
<div id="breadcrumb">
<div class="container"><div class="row"><div class="col-xs-12"><span id="guide">You are reading: </span><span><a id="guide-href"></a></span><span class="sep">&gt;</span> <span id="guide-section"><a id="guide-section-href"></a></span></div></div></div>
</div>
<a href="#0" class="cd-top">Top</a>
<a href="#" class="scrollup"><span class="fa fa-level-up"></span></a>
<!-- Google Tag Manager -->
<noscript><iframe src="//www.googletagmanager.com/ns.html?id={{ theme_googletag }}"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
@ -178,16 +35,4 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','{{ theme_googletag }}');</script>
<!-- End Google Tag Manager -->
<!-- RTP tag -->
<script type='text/javascript'>
(function(c,h,a,f,i){c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
c[a].a=i;var g=h.createElement("script");g.async=true;g.type="text/javascript";
g.src=f+'?aid='+i;var b=h.getElementsByTagName("script")[0];b.parentNode.insertBefore(g,b);
})(window,document,"rtp","//sjrtp7-cdn.marketo.com/rtp-api/v1/rtp.js","mirantis");
rtp('send','view');
rtp('get', 'campaign',true);
</script>
<!-- End of RTP tag -->
{% endblock %}

117
_templates/mirantis/globaltoc.html
View File

@ -1,10 +1,107 @@
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="{{ pathto(master_doc) }}">{{ theme_navbar_site_name }} <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc">{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}</ul>
</li>
<span id="left-col-toggle" class="fa fa-navicon"></span>
<ul class="list-group">
<li class="list-group-item list-group-header br-n">
Current Version
</li>
<li class="list-group-item">
<span class="badge badge-primary">7.0</span> Mirantis OpenStack
</li>
</ul>
<ul class="list-group">
<li class="list-group-item">
<form id="searchForm" action="search.html" method="get">
<input id="searchInput" type="text" name="q" placeholder="Search Documentation" />
<button class="btn btn-default" type="submit">Go</button>
</form>
</li>
</ul>
<div id="nav-spy" class="posr">
{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</div>
<ul class="list-group list-group-accordion">
<li class="list-group-item list-group-header br-n">
Additional Documentation
</li>
<li class="list-group-item">
<a class="reference internal sign-toggle">
Other Versions
</a>
<ul class="collapse">
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-6.1/"> Mirantis OpenStack 6.1 Docs </a>
</li>
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-6.0/"> Mirantis OpenStack 6.0 Docs </a>
</li>
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-5.1/"> Mirantis OpenStack 5.1.1 Docs </a>
</li>
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-5.1/"> Mirantis OpenStack 5.1 Docs </a>
</li>
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-5.0/"> Mirantis OpenStack 5.0.1 Docs </a>
</li>
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-4.1/"> Mirantis OpenStack 4.1 Docs </a>
</li>
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-4.0/"> Mirantis OpenStack 4.0 Docs </a>
</li>
<li class="">
<a href="https://docs.mirantis.com/fuel/fuel-3.2.1/"> Mirantis OpenStack 3.2 Docs </a>
</li>
<li class="">
<a href="https://software.mirantis.com/refdoc-fuelweb3/video/"> Fuel Web 3.0 Docs </a>
</li>
<li class="">
<a href="https://software.mirantis.com/refdoc-fuel3/preface/"> Fuel CLI 3.0 Docs </a>
</li>
<li class="">
<a href="https://software.mirantis.com/reference-documentation-on-fuel-folsom-2-1/introduction-3/"> Fuel 2.1 Docs </a>
</li>
<li class="">
<a href="https://software.mirantis.com/reference-documentation-on-fuel-folsom/package-contents-2/"> Fuel 2.0 Docs </a>
</li>
<li class="">
<a href="https://software.mirantis.com/reference-documentation-on-fuel-essex/package-contents/"> Fuel 1.0 Docs </a>
</li>
</ul>
</li>
<li class="list-group-item">
<a href="https://docs.fuel-infra.org/fuel-dev/" target="_blank">Developer's Guide</a>
</li>
<li class="list-group-item">
<a href="pdfs.html">Download PDFs</a>
</li>
</ul>
<ul class="list-group list-group-accordion">
<li class="list-group-item list-group-header br-n">
Additional Resources
</li>
<li class="list-group-item">
<a href="https://www.youtube.com/watch?v=DPYNK68toRY" target="_blank">Demo and Tutorial</a>
</li>
</ul>
<ul class="list-group list-group-accordion">
<li class="list-group-item list-group-header br-n">
Licenses
</li>
<li class="list-group-item">
<a href="eula.html">Fuel License</a>
</li>
<li class="list-group-item">
<a href="http://docs.mirantis.com/openstack/fuel/fuel-6.0/pdf/Mirantis-OpenStack-6.0-DEB-packages-licenses.pdf">DEB Packages Licenses</a>
</li>
<li class="list-group-item">
<a href="http://docs.mirantis.com/openstack/fuel/fuel-6.0/pdf/Mirantis-OpenStack-6.0-RPM-packages-licenses.pdf">RPM Packages Licenses</a>
</li>
<li class="list-group-item">
<a href="http://docs.mirantis.com/openstack/fuel/fuel-6.0/pdf/Mirantis-OpenStack-6.0-JS-libraries-licenses.pdf">JavaScript Libraries Licenses</a>
</li>
</ul>

54
_templates/mirantis/layout.html
View File

@ -13,22 +13,19 @@
{# BS2 needs "bootstrap-responsive.css". BS3 doesn't. #}
{% if theme_bootstrap_version == "3" %}
{% set theme_css_files = theme_css_files + [
'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css',
'https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css',
'_static/bootstrap-sphinx.css'
]
%}
{% else %}
{% set theme_css_files = theme_css_files + [
'_static/bootswatch-' + bootstrap_version + '/' + theme_bootswatch_theme + '/bootstrap.min.css',
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
'_static/bootstrap-sphinx.css'
]
%}
{% endif %}
{% else %}
{% set theme_css_files = theme_css_files + [
'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css',
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
'https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css',
'_static/bootstrap-sphinx.css',
'_static/styles.css'
]
@ -42,6 +39,8 @@
{% set script_files = script_files + [
'https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.js',
'https://cdnjs.cloudflare.com/ajax/libs/lunr.js/0.5.11/lunr.min.js',
'https://cdnjs.cloudflare.com/ajax/libs/jquery-hashchange/v1.3/jquery.ba-hashchange.min.js',
'_static/bootstrap-dropdown.js',
'_static/bootstrap-sphinx.js',
'_static/abtest.js',
@ -65,13 +64,9 @@
{% if theme_bootstrap_version == "3" %}
{%- macro bsidebar() %}
{%- if render_sidebar %}
<div class="{{ bs_span_prefix }}3">
<div id="sidebar" class="bs-sidenav" role="complementary">
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
</div>
</div>
{%- endif %}
{%- endmacro %}
{% else %}
@ -104,12 +99,43 @@
{%- block content %}
{{ navBar() }}
<div class="container">
<div class="row">
{%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
<div class="{{ bs_span_prefix }}{{ bs_content_width }}">
{% block body %}{% endblock %}
<div class="docs-container mt40" id="docs">
<div class="row table-layout">
<div class="col-xs-3 left-col">
{%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
</div>
<div class="col-xs-9 center-col va-t">
<div class="tab-content pn" id="docs-content">
{% block body %}{% endblock %}
{% if theme_navbar_sidebarrel %}
{% block sidebarrel %}
{% include "relations.html" %}
{% endblock %}
{% endif %}
<div class="top-wrapper clearfix">
<div class="row">
<div class="col-xs-2">
<a class="return-top">Share this page</a>
</div>
<div class="col-xs-4">
<div id="share" class="btn-group" role="group" aria-label="social">
<button data-toggle="tooltip" title="Copy permalink to clipboard" type="button" id="bottom-copy" class="btn btn-primary copyMe"><i class="fa fa-copy"></i></button>
<button data-toggle="tooltip" title="Share on Facebook" type="button" id="bottom-facebook" class="btn btn-primary"><i class="fa fa-facebook-official"></i></button>
<button data-toggle="tooltip" title="Share on Twitter" type="button" id="bottom-twitter" class="btn btn-primary"><i class="fa fa-twitter"></i></button>
<button data-toggle="tooltip" title="Share on Google+" type="button" id="bottom-google-plus" class="btn btn-primary"><i class="fa fa-google-plus"></i></button>
<button data-toggle="tooltip" title="Share on LinkedIn" type="button" id="bottom-linkedin" class="btn btn-primary"><i class="fa fa-linkedin"></i></button>
<button data-toggle="tooltip" title="Contribute" type="button" id="bottom-github" class="btn btn-primary"><i class="fa fa-github"></i></button>
</div>
</div>
<div class="col-xs-6 text-right">
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0;float: right;margin-left: 15px;margin-bottom: 15px;margin-top: 5px;" src="https://i.creativecommons.org/l/by-sa/3.0/88x31.png"></a>
<small>This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.</small>
</div>
</div>
</div>
</div>
</div>
</div>
{% block sidebar2 %} {# possible location for sidebar #} {% endblock %}
</div>
</div>
{%- endblock %}

89
_templates/mirantis/navbar.html
View File

@ -1,49 +1,46 @@
<div id="navbar" class="{{ theme_navbar_class }} navbar-default">
<nav class="navbar bg-light docs-navbar">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
{%- block sidebarlogo %}
<a class="navbar-brand" href="{{ pathto(theme_roottarget) }}" title="{{ project|e }}">
{%- if logo %}<img src="{{ pathto('_static/' + logo, 1) }}">{%- endif %}
</a>
{% if theme_navbar_title -%}<span id="site-title">{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}</span>{%- endif -%}
</a>
{%- endblock %}
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
{% if theme_navbar_links %}
{%- for link in theme_navbar_links %}
<li><a href="{{ pathto(*link[1:]) }}">{{ link[0] }}</a></li>
{%- endfor %}
{% endif %}
{% block navbartoc %}
{% include "globaltoc.html" %}
{% if theme_navbar_pagenav %}
{% include "navbartoc.html" %}
{% endif %}
{% endblock %}
{% if theme_navbar_sidebarrel %}
{% block sidebarrel %}
{% include "relations.html" %}
{% endblock %}
{% endif %}
{% block navbarextra %}
{% endblock %}
{% if theme_source_link_position == "nav" %}
<li class="hidden-sm">{% include "sourcelink.html" %}</li>
{% endif %}
</ul>
{% block navbarsearch %}
{% include "navbarsearchbox.html" %}
{% endblock %}
<div class="row">
<div class="col-xs-12 col_miramenu_int">
<div class="mm_miralogo" style="float: left; margin-right: 20px;">
<a href="https://www.mirantis.com/" title="Home" alt="Mirantis | The #1 Pure Play OpenStack Company" rel="home">
<img src="https://www.mirantis.com/wp-content/themes/pre2015/imgresp/responsive_logo_inverted.png" class="img-responsive">
</a>
</div>
<div class="hidden-xs hidden-sm" id="mira-menu-int">
<a href="https://www.mirantis.com/products/mirantis-openstack-software/" class="glink" id="miramenu1">Products</a>
<a href="https://www.mirantis.com/solutions/dev-test/" class="glink" id="miramenu2">Solutions</a>
<a href="https://www.mirantis.com/services/implementation/" class="glink" id="miramenu3">Services</a>
<a href="https://training.mirantis.com/" class="glink" id="miramenu4">Training</a>
<a href="https://www.mirantis.com/partners/" class="glink" id="miramenu5">Partners</a>
<a href="https://www.mirantis.com/openstack/" class="glink" id="miramenu6">Resources</a>
<a href="https://www.mirantis.com/support/enterprise-support-services/" class="glink" id="miramenu7">Support</a>
</div>
<div class="top-menu-social">
<a href="https://www.linkedin.com/company/mirantis" target="_blank" id="top-linkedin">
<span class="fa-stack fa-lg"><i class="fa fa-circle-thin fa-stack-2x"></i><i
class="fa fa-linkedin fa-stack-1x"></i></span>
</a>
<a href="https://www.facebook.com/MirantisUS" target="_blank" id="top-facebook">
<span class="fa-stack fa-lg">
<i class="fa fa-circle-thin fa-stack-2x"></i>
<i class="fa fa-facebook fa-stack-1x"></i>
</span>
</a>
<a href="https://twitter.com/MirantisIT" target="_blank" id="top-twitter">
<span class="fa-stack fa-lg">
<i class="fa fa-circle-thin fa-stack-2x"></i>
<i class="fa fa-twitter fa-stack-1x"></i>
</span>
</a>
<a href="https://plus.google.com/+MirantisOpenStackNow" target="_blank" id="top-google-plus">
<span class="fa-stack fa-lg">
<i class="fa fa-circle-thin fa-stack-2x"></i>
<i class="fa fa-google-plus fa-stack-1x"></i>
</span>
</a>
</div>
</div>
</div>
</div>
</div>
</nav>

32
_templates/mirantis/relations.html
View File

@ -1,19 +1,31 @@
{# Switch to icon instead of text in `sm` view size for BS3 only. #}
<section id="relations">
<div class="row">
<div class="col-xs-6">
{%- if prev %}
<li>
<div id="prev">
<div class="sphinx-content">
<a href="{{ prev.link|e }}" title="{{ _('Previous Chapter: ') + prev.title|striptags }}">
{%- if theme_bootstrap_version == "2" -%}<span class="icon-chevron-left visible-tablet"></span>{%- endif -%}
{%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-left visible-sm"></span>{%- endif -%}
<span class="hidden-sm hidden-tablet">{{ "&laquo;"|safe }} {{ prev.title|striptags|truncate(length=16, killwords=True) }}</span>
<span class="glyphicon glyphicon-chevron-left visible-sm"></span>
<span class="hidden-sm hidden-tablet">{{ "&laquo;"|safe }} {{ prev.title|striptags|truncate(length=36, killwords=True) }}</span>
</a>
</li>
<h4>View Previous Guide</h4>
</div>
</div>
{%- endif %}
</div>
<div class="col-xs-6">
{%- if next %}
<li>
<div id="next">
<div class="sphinx-content">
<a href="{{ next.link|e }}" title="{{ _('Next Chapter: ') + next.title|striptags }}">
{%- if theme_bootstrap_version == "2" -%}<span class="icon-chevron-right visible-tablet"></span>{%- endif -%}
{%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-right visible-sm"></span>{%- endif -%}
<span class="hidden-sm hidden-tablet">{{ next.title|striptags|truncate(length=16, killwords=True) }} {{ "&raquo;"|safe }}</span>
<span class="glyphicon glyphicon-chevron-right visible-sm"></span>
<span class="hidden-sm hidden-tablet">{{ next.title|striptags|truncate(length=36, killwords=True) }} {{ "&raquo;"|safe }}</span>
</a>
</li>
<h4>View Next Guide</h4>
</div>
</div>
{%- endif %}
</div>
</div>
</section>

382
_templates/mirantis/static/abtest.js
View File

@ -1,7 +1,6 @@
var _conv_host = (("https:" == document.location.protocol) ? "https://d9jmv9u00p0mv.cloudfront.net" : "http://cdn-1.convertexperiments.com");
document.write(unescape("%3Cscript src='" + _conv_host + "/js/10012224-10012014.js' type='text/javascript'%3E%3C/script%3E"));
//collector
jQuery.ajax({
url: "https://mirantis.jira.com/s/4ed53ccf16578ed4b1d4b6b7efa13491-T/en_USltmd6x/65007/316/1.4.25/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector-embededjs/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector-embededjs.js?locale=en-US&collectorId=23810080",
type: "get",
@ -9,292 +8,167 @@ jQuery.ajax({
dataType: "script"
});
(function () {
$(window).on("popstate", function (e) {
var activeTab = location.hash ? $('[href=' + location.hash + ']') : $('[href=#home]');
if (activeTab.length) {
activeTab.tab('show');
} else {
$('.nav-tabs a:first').tab('show');
}
});
})();
$(window).hashchange(function(){ showHashTab(); });
function showHashTab(){
if(location.hash){
var activeTab = $('[href=' + location.hash + ']');
if (activeTab.length) {
activeTab.tab('show');
}
}
console.log('showHashTab');
if(location.hash){
var activeTab = $('[href=' + location.hash + ']');
if (activeTab.length) {
activeTab.tab('show');
} else {
$('.nav-tabs a:first').tab('show');
}
}
}
function generateLinks(url, title) {
var currentLocation = window.location;
var linkUrl = currentLocation.protocol + '//' + currentLocation.host + currentLocation.pathname + url;
var facebook = generateFacebook(linkUrl);
var googlePlus = generateGooglePlus(linkUrl);
var linkedIn = generateLinkedIn(linkUrl, title);
var twitter = generateTwitter(linkUrl, title);
var copyMe = generateCopyButton(linkUrl);
return '<span class="share headerlink">' + copyMe + facebook + googlePlus + linkedIn + twitter + '</span>';
function getParameterByName(name) {
name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
results = regex.exec(location.search);
return results === null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
}
function generateFacebook(url) {
return '<a class="facebook" data-toggle="tooltip" data-placement="bottom" title="Share on Facebook" href="https://www.facebook.com/sharer/sharer.php?u=' + url + '"><i class="fa fa-facebook-square"></i></a>';
function prepareList(){
$('#contents ul.simple').find('li:has(ul)').unbind('click').click(function(event) {
if(this == event.target) {
$(this).toggleClass('expanded');
$(this).children('ul').toggle('medium');
}
return false;
}).addClass('collapsed').removeClass('expanded').children('ul').hide();
$('#contents ul.simple a').unbind('click').click(function() {
window.open($(this).attr('href'),'_self');
return false;
});
}
function generateGooglePlus(url) {
return '<a class="googlePlus" data-toggle="tooltip" data-placement="bottom" title="Share on Google Plus" href="https://plus.google.com/share?url=' + url + '"><i class="fa fa-google-plus-square"></i></a>';
}
$(document).ready(function () {
var url = window.location.pathname;
var filename = url.substring(url.lastIndexOf('/') + 1);
function generateLinkedIn(url, title) {
$('#bottom-copy').attr('data-clipboard-text', window.location.href);
$('#bottom-facebook').on('click', function(){
window.open('https://www.facebook.com/sharer/sharer.php?u=' + window.location.href);
});
$('#bottom-google-plus').on('click', function(){
window.open('https://plus.google.com/share?url=' + window.location.href);
});
$('#bottom-twitter').on('click', function(){
window.open('https://twitter.com/home?status=' + encodeURIComponent($( "h1" ).first().text()) + ' ' + encodeURIComponent(window.location.href));
});
$('#bottom-linkedin').on('click', function(){
var params = {
mini: 'true',
url: url,
title: title,
summary: title,
url: window.location.href,
title: $( "h1" ).first().text(),
summary: $( "h2" ).first().text(),
source: ''
};
var queryString = $.param(params);
return '<a class="linkedIn" data-toggle="tooltip" data-placement="bottom" title="Share on LinkedIn" href="https://www.linkedin.com/shareArticle?' + queryString + '"><i class="fa fa-linkedin-square"></i></a>';
}
window.open('https://www.linkedin.com/shareArticle?' + queryString);
});
$('#bottom-github').on('click', function(){
window.open('https://github.com/openstack/fuel-docs');
});
$('.headerlink').each(function () {
$(this).empty();
});
function generateTwitter(url, title) {
return '<a class="twitter" data-toggle="tooltip" data-placement="bottom" title="Share on Twitter" href="https://twitter.com/home?status=' + encodeURIComponent(title) + ' ' + encodeURIComponent(url) + '"><i class="fa fa-twitter-square"></i></a>';
}
$('[data-toggle="tooltip"]').tooltip();
function generateCopyButton(url) {
return '<a data-toggle="tooltip" data-placement="bottom" class="copyMe" data-clipboard-text="' + url + '" data-original-title="Copy permalink to clipboard"><i class="fa fa-clipboard"></i></a>';
}
$('pre').each(function(){
$('<div class="zero-clipboard"><span a data-toggle="tooltip" data-placement="top" data-original-title="Copy permalink to clipboard" class="btn-clipboard copy copyMe" data-clipboard-text="'+ $.trim($(this).text().replace(/"/g, '&quot;')) +'"><i class="fa fa-clipboard"></i></span></div>').insertBefore(this);
});
function populateGuides(guides) {
ZeroClipboard.config({
forceHandCursor: false,
swfPath: "https://cdnjs.cloudflare.com/ajax/libs/zeroclipboard/2.1.6/ZeroClipboard.swf"
});
var client = new ZeroClipboard($('.copyMe'));
$(guides).find('.section').each(function (i) {
var index = i + 1;
var el = $(this).find('.reference');
var href = $(el).attr('href');
var heading = $(el).text();
var content = $(this).find('p').html();
$('#guides').append('<div class="col-sm-3"><a href="' + href + '"><div class="panel panel-default"><div class="panel-body"><h4>' + heading + '</h4><p>' + content + '</p></div></div></a></div>');
});
client.on("ready", function (readyEvent) {
client.on("copy", function (event) {
var clipboard = event.clipboardData;
clipboard.setData("text/plain");
});
client.on('aftercopy', function (event) {
$(event.target).attr('title', 'Copied!').tooltip('fixTitle').tooltip('show');
});
});
var columns = $('#guides .col-sm-3');
for (var i = 0; i < columns.length; i += 4) {
columns.slice(i, i + 4).wrapAll("<div class='row'></div>");
}
$('a[data-toggle="tab"]').on('click', function (e) {
history.pushState({}, '', $(this).attr('href'));
});
}
$('a.toc-backref').contents().unwrap();
function populatePdfs(pdfs) {
$('a[href="contents.html"]').attr('href', 'index.html');
$(pdfs).each(function () {
var href = $(this).attr('href');
var link = $(this).text();
$('#pdfs').append('<div class="col-lg-6"><a class="btn btn-default red btn-block" href="' + href + '"><i class="fa fa-file-pdf-o"></i> ' + link + '</a></div>');
});
prepareList();
var columns = $('#pdfs .col-lg-6');
for (var i = 0; i < columns.length; i += 2) {
columns.slice(i, i + 2).wrapAll("<div class='row'></div>");
}
}
showHashTab();
function populateDownload(download) {
var el = $(download).find('h1 > .reference');
var href = $(el).attr('href');
var link = $(el).text();
var content = $(download).clone().find('h1').remove().end().find('.note').addClass('alert alert-info').end().html();
$('#download_content').append('<a href="' + href + '" class="btn btn-danger btn-lg btn-block" id="download_openstack">' + link + '</a>' + content);
}
if(/search.html$/.test(window.location.pathname)) {
function populateReleases(releases){
var index = lunr(function () {
this.field('title', {boost: 10});
this.field('body');
this.field('href');
this.ref('id');
});
$(releases).each(function(){
var href = $(this).attr('href');
var link = $(this).text();
$('#prior_releases_content').append('<div class="col-md-3"><a class="btn btn-default red btn-block" href="' + href + '">' + link + '</a></div>');
var store = {};
});
if (getParameterByName('q')) {
var columns = $('#prior_releases_content .col-md-3');
for (var i = 0; i < columns.length; i += 4) {
columns.slice(i, i + 4).wrapAll("<div class='row'></div>");
}
}
$('#search-results').append('<div class="loader"><div class="bounce1"></div><div class="bounce2"></div><div class="bounce3"></div></div>');
function populateContent(callback){
$.get("index_content.html", function (data) {
var homeTitle = $(data).find('.home-title').html();
var home = $(data).find('.what-is-mirantis-openstack').html();
var guides = $(data).find('#guides');
populateGuides(guides);
var pdfs = $(data).find('#pdf .reference');
populatePdfs(pdfs);
var download = $(data).find('#download-now');
populateDownload(download);
var releases = $(data).find('#prior-releases p .reference');
populateReleases(releases);
$('#home').html(home);
$('#main').html(homeTitle);
});
$.getJSON("_static/data.json", function (data) {
$(data).each(function (i, item) {
index.add({
title: item.title,
body: item.body,
href: item.url,
guide: item.guide,
id: i
});
store[i] = {title: item.title, body: item.body, guide: item.guide, href: item.url};
});
$.get("eula.html", function (data) {
var fuel_license = $(data).find('#fuel-license').html();
$('#fuel-license').html($(fuel_license).find('pre'));
});
var query = getParameterByName('q');
var length = 210;
var bodyText = '';
var results = index.search(query);
$.get("third-party-licenses.html", function (data) {
var third_party = $(data).find(".section > .section");
$(third_party).each(function (i, v) {
var el = $(v).find('.reference');
var href = $(el).attr('href');
var heading = $(el).text();
$('#third-party-licenses').append('<a class="btn btn-default red btn-block" href="' + href + '"><i class="fa fa-file-pdf-o"></i> ' + heading + '</a>');
});
});
$('#search-progress').hide();
$('#search-results').empty().append(
results.length ?
results.map(function (result) {
var el = $('<p>')
.append($('<a>')
.attr('href', store[result.ref].href)
.text(store[result.ref].title)
);
var body = store[result.ref].body.toLowerCase();
var bodySearch = body.search(query.toLowerCase());
if (bodySearch > 100) {
bodyText = jQuery.trim(store[result.ref].body).substring(bodySearch, bodySearch + length).split(" ").slice(0, -1).join(" ") + "...";
} else {
bodyText = jQuery.trim(store[result.ref].body).substring(0, length).split(" ").slice(0, -1).join(" ") + "...";
}
el.append($('<p>').text());
el.append($('<p>').html('<span class="text-muted">Guide: <em>' + store[result.ref].guide + '</em></span><br>' + bodyText));
return el;
}) : $('<p><strong>No results found</strong></p>')
callback();
}
);
function prepareList(){
$('#contents ul.simple').find('li:has(ul)').unbind('click').click(function(event) {
if(this == event.target) {
$(this).toggleClass('expanded');
$(this).children('ul').toggle('medium');
}
return false;
}).addClass('collapsed').removeClass('expanded').children('ul').hide();
$('#contents ul.simple a').unbind('click').click(function() {
window.open($(this).attr('href'),'_self');
return false;
});
}
$(document).ready(function () {
var url = window.location.pathname;
var filename = url.substring(url.lastIndexOf('/') + 1);
if (filename == 'index.html' || filename == '') {
$('ul.nav.navbar-nav li.dropdown').not('.globaltoc-container').hide();
populateContent(showHashTab);
}
// browser window scroll (in pixels) after which the "back to top" link is shown
var offset = 300,
scroll_top_duration = 700,
//grab the "back to top" link
$back_to_top = $('.cd-top');
//hide or show the "back to top" link
$(window).scroll(function () {
( $(this).scrollTop() > offset ) ? $back_to_top.addClass('cd-is-visible') : $back_to_top.removeClass('cd-is-visible');
});
//smooth scroll to top
$back_to_top.on('click', function (event) {
event.preventDefault();
$('body,html').animate({
scrollTop: 0,
}, scroll_top_duration
);
});
$('.headerlink').each(function () {
var parentTag = $( this ).parent().get( 0 ).tagName;
if(parentTag == 'H1' || parentTag == 'H2'){
$(this).replaceWith(generateLinks($(this).attr('href'), $(this).parent().children('.toc-backref').text()));
} else {
$(this).empty();
}
});
$('[data-toggle="tooltip"]').tooltip();
$('pre').each(function(){
$('<div class="zero-clipboard"><span a data-toggle="tooltip" data-placement="top" data-original-title="Copy permalink to clipboard" class="btn-clipboard copy copyMe" data-clipboard-text="'+ $.trim($(this).text().replace(/"/g, '&quot;')) +'"><i class="fa fa-clipboard"></i></span></div>').insertBefore(this);
});
ZeroClipboard.config({
forceHandCursor: false,
swfPath: "https://cdnjs.cloudflare.com/ajax/libs/zeroclipboard/2.1.6/ZeroClipboard.swf"
});
var client = new ZeroClipboard($('.copyMe'));
client.on("ready", function (readyEvent) {
client.on("copy", function (event) {
var clipboard = event.clipboardData;
clipboard.setData("text/plain");
});
client.on('aftercopy', function (event) {
$(event.target).attr('title', 'Copied!').tooltip('fixTitle').tooltip('show');
});
});
$('h1, h2, h3, h4').hover(function () {
var headerlink = $(this).children('.headerlink');
var links = headerlink.children('a');
$(headerlink, links).css('opacity', '1');
},
function () {
var headerlink = $(this).children('.headerlink');
var links = headerlink.children('a');
$(headerlink, links).css('opacity', '.3');
}
);
$('a[data-toggle="tab"]').on('click', function (e) {
history.pushState({}, '', $(this).attr('href'));
});
$('#home a[href=#guides], #home a[href=#downloads]').on('click', function(e){
var tab = $(this).attr('href');
$('.nav-tabs a[href="' + tab + '"]').tab('show');
});
$('a.toc-backref').contents().unwrap();
$('ul.nav.navbar-nav > li > a[href="contents.html"]').attr('href', 'index.html');
prepareList();
var lastId, curId, curText,
topMenu = $("#breadcrumb"),
topMenuHeight = topMenu.outerHeight()+15,
menuItems = $('ul.dropdown-menu.localtoc > li').find('a'),
scrollItems = menuItems.map(function(){
var item = $($(this).attr("href"));
if (item.length) { return item; }
});
$(window).scroll(function(){
var fromTop = $(this).scrollTop()+topMenuHeight;
var cur = scrollItems.map(function(){
if ($(this).offset().top < fromTop)
return this;
});
cur = cur[cur.length-1];
var ele = cur && cur.length ? cur[0] : "";
if(ele){curId = ele.id; curText = $(ele).find(':header:first').text(); }
$('#guide-href').text($('h1:first').text()).attr('href', window.location.pathname.split('/').pop());
if (lastId !== curId) {
lastId = curId;
$('#guide-section-href').text(curText).attr('href', '#'+curId);
}
if($(window).scrollTop() > 1000){
$('#breadcrumb').fadeIn();
} else {
$('#breadcrumb').hide();
}
});
});
}
}
});

425
_templates/mirantis/static/bootstrap-sphinx.js_t
View File

@ -1,150 +1,307 @@
(function ($) {
/**
* Patch TOC list.
*
* Will mutate the underlying span to have a correct ul for nav.
*
* @param $span: Span containing nested UL's to mutate.
* @param minLevel: Starting level for nested lists. (1: global, 2: local).
*/
var patchToc = function ($ul, minLevel) {
var findA,
patchTables,
$localLi;
/**
* Patch TOC list.
*
* Will mutate the underlying span to have a correct ul for nav.
*
* @param $span: Span containing nested UL's to mutate.
* @param minLevel: Starting level for nested lists. (1: global, 2: local).
*/
// Find all a "internal" tags, traversing recursively.
findA = function ($elem, level) {
level = level || 0;
var $items = $elem.find("> li > a.internal, > ul, > li > ul");
var patchToc = function ($ul, minLevel) {
var findA,
patchTables,
$localLi;
// Iterate everything in order.
$items.each(function (index, item) {
var $item = $(item),
tag = item.tagName.toLowerCase(),
$childrenLi = $item.children('li'),
$parentLi = $($item.parent('li'), $item.parent().parent('li'));
// Find all a "internal" tags, traversing recursively.
findA = function ($elem, level) {
level = level || 0;
var $items = $elem.find("> li > a.internal, > ul, > li > ul");
// Add dropdowns if more children and above minimum level.
if (tag === 'ul' && level >= minLevel && $childrenLi.length > 0) {
$parentLi
.addClass('dropdown-submenu')
.children('a').first().attr('tabindex', -1);
// Iterate everything in order.
$items.each(function (index, item) {
var $item = $(item),
tag = item.tagName.toLowerCase(),
$childrenLi = $item.children('li'),
$parentLi = $($item.parent('li'), $item.parent().parent('li'));
$item.addClass('dropdown-menu');
}
// Add dropdowns if more children and above minimum level.
if (tag === 'ul' && level >= minLevel && $childrenLi.length > 0) {
$parentLi
.addClass('dropdown-submenu')
.children('a').first().attr('tabindex', -1);
findA($item, level + 1);
});
$item.addClass('dropdown-menu');
}
findA($item, level + 1);
});
};
findA($ul);
};
findA($ul);
};
/**
* Patch all tables to remove ``docutils`` class and add Bootstrap base
* ``table`` class.
*/
patchTables = function () {
$("table.docutils")
.removeClass("docutils")
.addClass("table")
.attr("border", 0);
};
$(window).load(function () {
/*
* Scroll the window to avoid the topnav bar
* https://github.com/twbs/bootstrap/issues/1768
/**
* Patch all tables to remove ``docutils`` class and add Bootstrap base
* ``table`` class.
*/
if ($("#navbar.navbar-fixed-top").length > 0) {
var navHeight = $("#navbar").height(),
shiftWindow = function() { scrollBy(0, -navHeight - 20); };
patchTables = function () {
$("table.docutils")
.removeClass("docutils")
.addClass("table")
.attr("border", 0);
};
if (location.hash) {
setTimeout(shiftWindow, 1);
}
$(window).load(function () {
/*
* Scroll the window to avoid the topnav bar
* https://github.com/twbs/bootstrap/issues/1768
*/
if ($("#navbar.navbar-fixed-top").length > 0) {
var navHeight = $("#navbar").height(),
//shiftWindow = function() { scrollBy(0, -navHeight - 20); };
shiftWindow = function() { console.log('shiftWindow'); window.scrollTo(0, 0); };
window.addEventListener("hashchange", shiftWindow);
}
});
if (location.hash) {
setTimeout(shiftWindow, 1);
}
$(document).ready(function () {
// Add styling, structure to TOC's.
$(".dropdown-menu").each(function () {
$(this).find("ul").each(function (index, item){
var $item = $(item);
$item.addClass('unstyled');
});
window.addEventListener("hashchange", shiftWindow);
}
});
// Global TOC.
if ($("ul.globaltoc li").length) {
patchToc($("ul.globaltoc"), 1);
} else {
// Remove Global TOC.
$(".globaltoc-container").remove();
}
// Local TOC.
$(".bs-sidenav ul").addClass("nav nav-list");
$(".bs-sidenav > ul > li > a").addClass("nav-header");
// Local TOC.
patchToc($("ul.localtoc"), 2);
// Mutate sub-lists (for bs-2.3.0).
$(".dropdown-menu ul").not(".dropdown-menu").each(function () {
var $ul = $(this),
$parent = $ul.parent(),
tag = $parent[0].tagName.toLowerCase(),
$kids = $ul.children().detach();
// Replace list with items if submenu header.
if (tag === "ul") {
$ul.replaceWith($kids);
} else if (tag === "li") {
// Insert into previous list.
$parent.after($kids);
$ul.remove();
}
});
// Add divider in page TOC.
$localLi = $("ul.localtoc li");
if ($localLi.length > 2) {
$localLi.first().after('<li class="divider"></li>');
}
// Manually add dropdown.
// Appears unnecessary as of:
// https://github.com/ryan-roemer/sphinx-bootstrap-theme/pull/90
// Remove next time around...
// a.dropdown-toggle class needed in globaltoc.html
//$('.dropdown-toggle').dropdown();
// Patch tables.
patchTables();
// Add Note, Warning styles. (BS v2,3 compatible).
$('.admonition').addClass('alert alert-info')
.filter('.warning, .caution')
.removeClass('alert-info')
.addClass('alert-warning').end()
.filter('.error, .danger')
.removeClass('alert-info')
.addClass('alert-danger alert-error').end();
// Inline code styles to Bootstrap style.
$('tt.docutils.literal').not(".xref").each(function (i, e) {
// ignore references
if (!$(e).parent().hasClass("reference")) {
$(e).replaceWith(function () {
return $("<code />").html($(this).html());
$(document).ready(function () {
// Add styling, structure to TOC's.
$(".dropdown-menu").each(function () {
$(this).find("ul").each(function (index, item){
var $item = $(item);
$item.addClass('unstyled');
});
});
}});
// Update sourcelink to remove outerdiv (fixes appearance in navbar).
var $srcLink = $(".nav #sourcelink");
$srcLink.parent().html($srcLink.html());
});
}(window.$jqTheme || window.jQuery));
// Global TOC.
if ($("ul.globaltoc li").length) {
patchToc($("ul.globaltoc"), 1);
} else {
// Remove Global TOC.
$(".globaltoc-container").remove();
}
$('h1').first().addClass('page-header');
$('#contents').remove();
$('.center-col > .tab-content > .section > .section').each(function(){
$(this).addClass('tab-pane fade');
if($(this).hasClass('active')){
$(this).addClass('in');
}
});
if(!$('.center-col > .tab-content> .section > .section').hasClass('active')){
$('.center-col > .tab-content> .section > .section').first().addClass('active in');
}
$('.center-col > .tab-content> .section > .section').unwrap();
// Local TOC.
//$(".bs-sidenav ul").addClass("nav nav-list");
$("#nav-spy > ul").addClass("list-group list-group-accordion");
$("#nav-spy > ul > li").addClass("list-group-item");
$("#nav-spy > ul > li").each(function(){
if($(this).hasClass('current')){
$(this).addClass('active');
}
});
$("#nav-spy > ul > li").each(function(){
$(this).has('ul').children().first('a').addClass('sign-toggle').removeAttr("href");
});
$("#nav-spy > ul > li > ul").addClass("collapse");
// $('#nav-spy > ul').prepend('<li class="list-group-item list-group-header br-n">Documentation Menu</li>');
var scrollBtn = $('.scrollup');
// on scoll toggle scrollTop in/out
$(window).scroll(function () {
if ($('body').hasClass('scrolling')) {return;}
if ($(this).scrollTop() > 300) {
scrollBtn.fadeIn();
} else {
scrollBtn.fadeOut();
}
});
// on button click scrollTop
$('.scrollup, .return-top').on('click', function (e) {
e.preventDefault();
scrollReset();
});
// if link item clicked scrollTop
$('#nav-spy li a').on('click', function (e) {
if ($(this).hasClass('sign-toggle')) { return; }
var href = $(this).attr('href');
if (!href.split('#')[0]) { e.preventDefault(); window.location.hash = href; }
windowCheck();
});
function windowCheck(){
if ($(window).scrollTop() > 234) {
scrollReset(135);
}
if($(document).width() < 941) {
if ($('body.left-col-hidden').length == 0) {
$('body').addClass('left-col-hidden');
}
}
}
// scrollTop function
function scrollReset(pos) {
if(pos == undefined) { pos = 0; }
scrollBtn.fadeOut();
$("html, body").addClass('scrolling').animate({
scrollTop: pos
}, 320, function(){
$("html, body").removeClass('scrolling')
});
return false;
}
function nav(){
$('.dynamic-nav').remove();
$('.sphinx-content').hide();
var current_id = document.location.hash;
var current_page = $(current_id);
var prev_header = '';
var next_header = '';
var prev = $(current_page).prev('div.section');
var next = $(current_page).next('div.section');
if(prev.length == 0){
$('#prev > .sphinx-content').show();
} else {
prev_header = '&laquo; ' + $(prev).find(':header:first').text().replace(/[^\x00-\x7F]/g,'');
var prevEl = $('<div class="dynamic-nav"><a href="#'+ $(prev).attr('id') + '">'+prev_header+'</a><h4>View Previous Section</h4></div>');
$('#prev').append(prevEl);
prevEl.one('click', function(){
windowCheck();
})
}
if(next.length == 0){
$('#next > .sphinx-content').show();
} else {
next_header = $(next).find(':header:first').text().replace(/[^\x00-\x7F]/g,'') + ' &raquo;';
var nextEl = $('<div class="dynamic-nav"><a href="#'+ $(next).attr('id') + '">'+next_header+'</a><h4>View Next Section</h4></div>');
$('#next').append(nextEl);
nextEl.one('click', function(){
windowCheck();
})
}
}
nav();
$(window).hashchange(function(){ nav(); });
// list-group-accordion functionality
var listAccordion = $('.list-group-accordion');
var accordionItems = listAccordion.find('.list-group-item');
var accordionLink = listAccordion.find('.sign-toggle');
accordionLink.on('click', function() {
var This = $(this);
var Parent = This.parent('.list-group-item');
if (Parent.hasClass('active')) {
Parent.toggleClass('active');
} else {
accordionItems.removeClass('active');
Parent.addClass('active');
}
});
var toggleInput = $('#left-col-toggle');
toggleInput.on('click', function() {
if ($('body.left-col-hidden').length) {
$('body').removeClass('left-col-hidden');
} else {
$('body').addClass('left-col-hidden');
}
});
if($(document).width() < 941) {
if ($('body.left-col-hidden').length == 0) {
$('body').addClass('left-col-hidden');
}
}
// Local TOC.
patchToc($("ul.localtoc"), 2);
// Mutate sub-lists (for bs-2.3.0).
$(".dropdown-menu ul").not(".dropdown-menu").each(function () {
var $ul = $(this),
$parent = $ul.parent(),
tag = $parent[0].tagName.toLowerCase(),
$kids = $ul.children().detach();
// Replace list with items if submenu header.
if (tag === "ul") {
$ul.replaceWith($kids);
} else if (tag === "li") {
// Insert into previous list.
$parent.after($kids);
$ul.remove();
}
});
// Add divider in page TOC.
$localLi = $("ul.localtoc li");
if ($localLi.length > 2) {
$localLi.first().after('<li class="divider"></li>');
}
// Manually add dropdown.
// Appears unnecessary as of:
// https://github.com/ryan-roemer/sphinx-bootstrap-theme/pull/90
// Remove next time around...
// a.dropdown-toggle class needed in globaltoc.html
//$('.dropdown-toggle').dropdown();
// Patch tables.
patchTables();
// Add Note, Warning styles. (BS v2,3 compatible).
$('.admonition').addClass('alert alert-info')
.filter('.warning, .caution')
.removeClass('alert-info')
.addClass('alert-warning').end()
.filter('.error, .danger')
.removeClass('alert-info')
.addClass('alert-danger alert-error').end();
// Inline code styles to Bootstrap style.
$('tt.docutils.literal').not(".xref").each(function (i, e) {
// ignore references
if (!$(e).parent().hasClass("reference")) {
$(e).replaceWith(function () {
return $("<code />").html($(this).html());
});
}});
// Update sourcelink to remove outerdiv (fixes appearance in navbar).
var $srcLink = $(".nav #sourcelink");
$srcLink.parent().html($srcLink.html());
});
}(window.$jqTheme || window.jQuery));

371
_templates/mirantis/static/index.html
View File

@ -1,371 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Welcome to Mirantis OpenStack Documentation &mdash; Mirantis OpenStack v7.0 | Documentation</title>
<link rel="stylesheet" href="_static/basic.css" type="text/css"/>
<link rel="stylesheet" href="_static/pygments.css" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css"
type="text/css"/>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css"/>
<link rel="stylesheet" href="_static/styles.css" type="text/css"/>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '6.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/bootstrap-dropdown.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<script type="text/javascript" src="_static/abtest.js"></script>
<script type="text/javascript"
src="https://cdnjs.cloudflare.com/ajax/libs/zeroclipboard/2.2.0/ZeroClipboard.js"></script>
<link rel="shortcut icon" href="_static/mirantis_icon.ico"/>
<link rel="top" title="Mirantis OpenStack v6.1 | Documentation" href="contents.html"/>
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
</head>
<body role="document">
<div id="navbar" class="navbar navbar-default">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#" title="Mirantis OpenStack"><img src="_static/mirantis_logo.png"></a>
<span id="site-title">Documentation</span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="hidden-sm"></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search"/>
</div>
<input type="hidden" name="check_keywords" value="yes"/>
<input type="hidden" name="area" value="default"/>
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-12">
<div class="section" id="mirantis-openstack-documentation">
<span id="homepage"></span><span id="index-0"></span>
<h1 id="main">Mirantis OpenStack Documentation</h1>
<div role="tabpanel">
<!-- Nav tabs -->
<ul id="menuNav" class="nav nav-tabs" role="tablist">
<li role="presentation" class="active"><a href="#home" aria-controls="home" role="tab"
data-toggle="tab">What is Mirantis OpenStack</a></li>
<li role="presentation"><a href="#guides" aria-controls="guides" role="tab" data-toggle="tab">Guides</a>
</li>
<li role="presentation"><a href="#licenses" aria-controls="license" role="tab"
data-toggle="tab">Licenses</a></li>
<li role="presentation"><a href="#demos-and-tutorials" aria-controls="demos-and-tutorials"
role="tab" data-toggle="tab">Demos & Tutorials</a></li>
<li role="presentation"><a href="#downloads" aria-controls="downloads" role="tab"
data-toggle="tab">Downloads</a></li>
<li role="presentation"><a href="#prior-releases" aria-controls="prior-releases" role="tab"
data-toggle="tab">Prior Releases</a></li>
</ul>
<!-- Tab panes -->
<div class="tab-content">
<div role="tabpanel" class="tab-pane fade in active" id="home">
<div id="preview-area">
<div class="spinner">
<div class="bounce1"></div>
<div class="bounce2"></div>
<div class="bounce3"></div>
</div>
</div>
</div>
<div role="tabpanel" class="tab-pane fade" id="guides">
<!-- placeholder for guides -->
</div>
<div role="tabpanel" class="tab-pane fade" id="licenses">
<div class="col-sm-8">
<h4>Fuel License</h4>
<div class="highlight-none">
<div class="highlight" id="fuel-license"></div>
</div>
</div>
<div class="col-sm-4">
<h4>Third-Party Components Licenses</h4>
<div id="third-party-licenses">
</div>
</div>
</div>
<div role="tabpanel" class="tab-pane fade" id="demos-and-tutorials">
<div class="col-sm-8">
<div class="embed-responsive embed-responsive-16by9">
<iframe class="embed-responsive-item"
src="https://www.youtube.com/embed/DPYNK68toRY?rel=0"></iframe>
</div>
</div>
<div class="col-sm-4">
<div class="panel panel-default panel-sidebar">
<!-- Default panel contents -->
<div class="panel-heading">
Mirantis OpenStack Demo & Tutorial
</div>
<div class="panel-body panel-sidebar">
<p>
With <a href="http://software.mirantis.com">Mirantis OpenStack 7.0</a> Mirantis responds to the needs of our largest cloud customers running mission-critical workloads with the most stable OpenStack distribution that has been tested extensively, includes features to simplify operations at web-scale and makes it easier to deploy workloads on OpenStack.</p><p>Based on the Kilo release, Mirantis OpenStack also includes extensive eco-system support including new features for VMware.</p>
</p>
</div>
</div>
</div>
</div>
<div role="tabpanel" class="tab-pane fade" id="downloads">
<div class="col-sm-4">
<div id="download_content">
<h3>Download Mirantis OpenStack</h3>
</div>
</div>
<div class="col-sm-8">
<div id="pdfs">
<h3>Download Mirantis OpenStack Guides</h3>
</div>
</div>
</div>
<div role="tabpanel" class="tab-pane fade" id="prior-releases">
<div class="col-sm-12">
<h3 class="no-margin">Prior Releases</h3>
<div id="prior_releases_content">
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<section class="fsprod">
<div class="container">
<div class="row">
<div class="col-md-6">
<ul style="margin-bottom:0;">
<li><a class="fmenu_section" href="https://www.mirantis.com/products/mirantis-openstack-software/"
style="margin-top: 15px;">Products</a></li>
</ul>
<div class="row">
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/mirantis-openstack-software/"
class="fproduct">
<div class="footerglyph1"></div>
<span>Mirantis <br>OpenStack Software</span></a></div>
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/application-catalog-murano/"
class="fproduct">
<div class="footerglyph2"></div>
<span>Application <br>Catalog Murano</span></a></div>
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/openstack-drivers-and-plugins/"
class="fproduct">
<div class="footerglyph3"></div>
<span>OpenStack Drivers <br>and Plugins</span></a></div>
<div class="col-md-3 col-sm-3 col-xs-3"><a href="https://www.mirantis.com/products/unlocked-appliances/" class="fproduct">
<div class="footerglyph4"></div>
<span>Unlocked <br>Appliances</span></a></div>
</div>
</div>
<hr class="hidden-lg hidden-md">
<div class="col-md-3 col-sm-6 col-xs-6 hidden-sm hidden-xs ">
<ul>
<li><a class="fmenu_section" style="margin-top: 15px;">Solutions</a></li>
<li><a href="https://www.mirantis.com/solutions/dev-test/">Dev/Test</a></li>
<li><a href="https://www.mirantis.com/solutions/platform-as_a_service_paas/">PaaS</a></li>
<li><a href="https://www.mirantis.com/solutions/container-technologies/">Containers</a></li>
<li><a href="https://www.mirantis.com/solutions/network-functions-virtualization-nfv/">NFV</a></li>
<li><a href="https://www.mirantis.com/solutions/hybrid-cloud/">Hybrid Cloud</a></li>
<li><a href="https://www.mirantis.com/solutions/industry-solutions/">Industry Solutions</a></li>
</ul>
</div>
<div class="col-md-3 col-sm-6 col-xs-6">
<ul>
<li><a class="fmenu_section" style="margin-top: 15px;">Support</a></li>
<li><a href="https://www.mirantis.com/support/enterprise-support-services/">Enterprise Support</a></li>
<li><a href="https://www.mirantis.com/products/mirantis-openstack-software/">Download and
Install</a></li>
<li><a href="https://www.mirantis.com/products/mirantis-openstack-software/documentation/">Documentation</a></li>
<li><a href="https://ask.openstack.org/">Community</a>
</li>
<li><a href="https://software.mirantis.com/mirantis-openstack-technical-bulletins/">Product Updates</a>
</li>
</ul>
</div>
<div class="hidden-lg hidden-md col-sm-6 col-xs-6">
<ul>
<li><a class="fmenu_section" href="https://www.mirantis.com/company/about-pure-play-openstack/"
style="margin-top: 15px;">Company</a></li>
<li><a href="https://online.mirantis.com/contact-us">Get In Touch</a></li>
<li><a href="https://www.mirantis.com/contact/">Locations</a></li>
<li><a href="https://www.mirantis.com/careers/">Careers</a></li>
<li><a href="https://www.mirantis.com/company/leadership/">Management</a></li>
<li><a href="https://www.mirantis.com/company/investors/">Investors</a></li>
<li><a href="https://www.mirantis.com/company/leadership/board-of-directors/">Board of Directors</a></li>
<li><a href="https://www.mirantis.com/company/press-center/info/">Press Center</a></li>
</ul>
</div>
</div>
<hr class="hidden-lg hidden-md hidden-sm hidden-xs">
</div>
</section>
<section class="fscomp">
<div class="container footsm hidden-sm hidden-xs">
<div class="row">
<div class="col-md-2">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">Services</a></li>
<li><a href="https://www.mirantis.com/services/managed-services/">Managed Services</a></li>
<li><a href="https://www.mirantis.com/services/assessment/">Assessment</a></li>
<li><a href="https://www.mirantis.com/services/implementation/">Implementation</a></li>
<li><a href="https://www.mirantis.com/services/enterprise-support-services/">Enterprise Support</a></li>
<li><a href="https://www.mirantis.com/services/migration-services/">Migration Services</a></li>
<li><a href="https://www.mirantis.com/services/drivers-upstreaming-maintenance/">Driver Development</a></li>
</ul>
</div>
<div class="col-md-2 hidden-sm">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">Training</a></li>
<li><a href="https://training.mirantis.com/openstack-courses">OpenStack Courses</a></li>
<li><a href="https://training.mirantis.com/certification">Certification</a></li>
<li><a href="https://training.mirantis.com/online-virtual-training">Virtual Training</a></li>
<li><a href="https://training.mirantis.com/training/onsite.html">OnSite Training</a></li>
<li><a href="https://training.mirantis.com/online-resources">Training Resources</a></li>
</ul>
</div>
<div class="col-md-2 hidden-sm">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">Partners</a></li>
<li><a href="https://www.mirantis.com/partners/">Overview</a></li>
<li><a href="https://www.mirantis.com/partners/mirantis-unlocked-partner-solutions/">Partner list</a></li>
<li><a href="https://www.mirantis.com/partners/mirantis-channel-partners/">Channel Partners</a></li>
<li><a href="https://www.mirantis.com/partners/service-providers/">Service Providers</a></li>
<li><a href="https://training.mirantis.com/mirantis-training-partner-program-intro/">Training
Partners</a></li>
<li><a href="https://www.mirantis.com/partners/become-mirantis-technology-partner/">Become a Partner</a></li>
</ul>
</div>
<div class="col-md-3 hidden-sm">
<ul>
<li><a class="fmenu_section" style="font-weight:normal;">OpenStack Now</a></li>
<li><a href="https://www.mirantis.com/blog/">Blog</a></li>
<li><a href="https://www.mirantis.com/openstack/">News</a></li>
<li><a href="https://www.mirantis.com/openstack/tutorials/">Tutorials</a></li>
<li><a href="https://www.mirantis.com/openstack/news/community-news/">Community/Events</a></li>
<li><a href="http://online.mirantis.com/openstack-now-newsletter/">Subscribe</a></li>
</ul>
</div>
<div class="col-md-3 hidden-sm">
<ul>
<li><a class="fmenu_section" href="https://www.mirantis.com/company/about-pure-play-openstack/"
style="font-weight:normal;">Company</a></li>
<li><a href="https://online.mirantis.com/contact-us">Get In Touch</a></li>
<li><a href="https://www.mirantis.com/contact/">Locations</a></li>
<li><a href="https://www.mirantis.com/careers/">Careers</a></li>
<li><a href="https://www.mirantis.com/company/leadership/">Management</a></li>
<li><a href="https://www.mirantis.com/company/investors/">Investors</a></li>
<li><a href="https://www.mirantis.com/company/leadership/board-of-directors/">Board of Directors</a></li>
<li><a href="https://www.mirantis.com/company/press-center/info/">Press Center</a></li>
</ul>
</div>
</div>
</div>
</section>
<div class="clear"></div>
<div class="footer_copy">
<div class="container">
<div class="row">
<div class="col-md-3 col-sm-3 col-logo text-left-lg text-left-md text-left-sm text-center-xs">
<span class="mira_btm">Mirantis Inc.</span> <br>
<span class="pureplay_btm">Pure Play OpenStack.</span>
</div>
<div class="col-md-4 col-sm-5 col-copy text-center">
<span class="copy_btm">&copy; 2005 &mdash; 2015 Mirantis, Inc.<br><span
style="font-size: 10px; opacity:0.6; line-height: 0.9em; display:inline-block;margin-top:5px; ">All rights reserved. "Mirantis" and "FUEL" are are registered trademarks of Mirantis, Inc. All other trademarks are the property of their respective owners.</span></span>
</div>
<div class="col-md-5 col-sm-4 col-address text-right-lg text-right-md text-right-sm text-center-xs">
<span class="mira_btm">615 National Avenue, Suite 100 Mountain View, CA 94043<br>
+1-650-963-9828</span>
</div>
</div>
<div class="row">
<div class="col-md-3 col-sm-3 col-logo">
</div>
<div class="col-md-4 col-sm-4 cc">
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/3.0/88x31.png"></a><br>This work is
licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative
Commons Attribution-ShareAlike 3.0 Unported License</a>.
</div>
</div>
</div>
</div>
</footer>
<a href="#0" class="cd-top">Top</a>
<!-- Google Tag Manager -->
<noscript>
<iframe src="//www.googletagmanager.com/ns.html?id=GTM-K2J65K"
height="0" width="0" style="display:none;visibility:hidden"></iframe>
</noscript>
<script>(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({
'gtm.start': new Date().getTime(), event: 'gtm.js'
});
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : '';
j.async = true;
j.src =
'//www.googletagmanager.com/gtm.js?id=' + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-K2J65K');</script>
<!-- End Google Tag Manager -->
<!-- RTP tag -->
<script type='text/javascript'>
(function(c,h,a,f,i){c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
c[a].a=i;var g=h.createElement("script");g.async=true;g.type="text/javascript";
g.src=f+'?aid='+i;var b=h.getElementsByTagName("script")[0];b.parentNode.insertBefore(g,b);
})(window,document,"rtp","//sjrtp7-cdn.marketo.com/rtp-api/v1/rtp.js","mirantis");
rtp('send','view');
rtp('get', 'campaign',true);
</script>
<!-- End of RTP tag -->
</body>
</html>

5
_templates/mirantis/static/searchtools.js Normal file
View File

@ -0,0 +1,5 @@
var Search = {
loadIndex : function(url) {
return false;
}
};

822
_templates/mirantis/static/styles.css
View File

File diff suppressed because one or more lines are too long

832
common_conf.py
View File

@ -1,416 +1,416 @@
# -*- coding: utf-8 -*-
#
# "Fuel" documentation build configuration file, created by
# sphinx-quickstart on Tue Sep 25 14:02:29 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- 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.
#if on_rtd:
# extensions = ['sphinx.ext.autodoc','sphinxcontrib.plantuml']
# display_github = False
#else:
extensions = ['sphinx.ext.autodoc','rst2pdf.pdfbuilder','sphinxcontrib.plantuml']
#,'sphinxcontrib.fancybox']
plantuml = ['java','-jar','/sbin/plantuml.jar']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
# master_doc = 'contents'
# General information about the project.
project = u'Mirantis OpenStack'
copyright = u'2015, Mirantis Inc.'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '7.0'
# The full version, including alpha/beta/rc tags.
release = '7.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# exclude_patterns = ['_*', 'rn_index.rst']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- 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 = "mirantis"
# 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 = {
# Navigation bar title. (Default: ``project`` value)
'navbar_title': "Documentation",
# Tab name for entire site. (Default: "Site")
'navbar_site_name': "Guide",
# A list of tuples containing pages or urls to link to.
# Valid tuples should be in the following forms:
# (name, page) # a link to a page
# (name, "/aa/bb", 1) # a link to an arbitrary relative url
# (name, "http://example.com", True) # arbitrary absolute url
# Note the "1" or "True" value above as the third argument to indicate
# an arbitrary url.
# 'navbar_links': [
# ("Examples", "examples"),
# ("Link", "http://example.com", True),
# ],
# Render the next and previous page links in navbar. (Default: true)
'navbar_sidebarrel': True,
# Render the current pages TOC in the navbar. (Default: true)
'navbar_pagenav': True,
# Tab name for the current pages TOC. (Default: "Page")
'navbar_pagenav_name': "Section",
# Global TOC depth for "site" navbar tab. (Default: 1)
# Switching to -1 shows all levels.
'globaltoc_depth': 2,
# Include hidden TOCs in Site navbar?
#
# Note: If this is "false", you cannot have mixed ``:hidden:`` and
# non-hidden ``toctree`` directives in the same page, or else the build
# will break.
#
# Values: "true" (default) or "false"
'globaltoc_includehidden': "true",
# HTML navbar class (Default: "navbar") to attach to <div> element.
# For black navbar, do "navbar navbar-inverse"
'navbar_class': "navbar",
# Fix navigation bar to top of page?
# Values: "true" (default) or "false"
'navbar_fixed_top': "true",
# Location of link to source.
# Options are "nav" (default), "footer" or anything else to exclude.
'source_link_position': "nav",
# Bootswatch (http://bootswatch.com/) theme.
#
# Options are nothing (default) or the name of a valid theme
# such as "amelia" or "cosmo".
'bootswatch_theme': "yeti",
# Choose Bootstrap version.
# Values: "3" (default) or "2" (in quotes)
'bootstrap_version': "3",
}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_templates']
# html_add_permalinks = None
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = project + ' v' + release + ' | Documentation'
html_title = project + ' v' + release + ' | Documentation'
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '_static/mirantis_logo.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = '_static/mirantis_icon.ico'
# 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']
# A list of paths that contain extra files not directly related to the
# documentation, such as robots.txt or .htaccess. Relative paths are taken
# as relative to the configuration directory. They are copied to the output
# directory. They will overwrite any existing file of the same name.
html_extra_path = ['_templates/mirantis/static/index.html', '_templates/mirantis/static/search.html', 'examples']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%c, %Z'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
html_use_smartypants = False
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {
# '**': ['searchbox.html', 'globaltoc.html'],
#}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
html_use_index = True
# If true, the index is split into individual pages for each letter.
html_split_index = False
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'fueldoc'
# -- 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': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
fuel = [
('install', 'install.tex', u'Fuel Installation Guide | Documentation',
u'Mirantis Inc.', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'fuel', u'Mirantis OpenStack | Documentation',
[u'Mirantis'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'fuel', u'Fuel for OpenStack | Documentation',
u'Mirantis Inc.', 'fuel', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# -- Additional Settings -------------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# extensions += ['sphinx.ext.inheritance_diagram', 'sphinxcontrib.blockdiag', 'sphinxcontrib.actdiag', 'sphinxcontrib.seqdiag', 'sphinxcontrib.nwdiag']
# The encoding of source files.
source_encoding = 'utf-8'
#source_encoding = 'shift_jis'
# The language for content autogenerated by Sphinx.
#language = 'en'
#language = 'ja'
# Enable Antialiasing
blockdiag_antialias = True
acttdiag_antialias = True
seqdiag_antialias = True
nwdiag_antialias = True
extensions += ['rst2pdf.pdfbuilder']
# pdf_documents = [
# (master_doc, project, project, copyright),
# ]
pdf_stylesheets = ['letter', 'mirantis']
pdf_style_path = ['_templates']
#pdf_language = "en"
# Mode for literal blocks wider than the frame. Can be
# overflow, shrink or truncate
pdf_fit_mode = "shrink"
# Section level that forces a break page.
# For example: 1 means top-level sections start in a new page
# 0 means disabled
pdf_break_level = 1
# When a section starts in a new page, force it to be 'even', 'odd',
# or just use 'any'
pdf_breakside = 'any'
# Insert footnotes where they are defined instead of
# at the end.
#pdf_inline_footnotes = True
# verbosity level. 0 1 or 2
pdf_verbosity = 0
# If false, no index is generated.
#pdf_use_index = True
# If false, no modindex is generated.
#pdf_use_modindex = False
# If false, no coverpage is generated.
# pdf_use_coverpage = False
# Name of the cover page template to use
pdf_cover_template = 'mirantiscover.tmpl'
# Documents to append as an appendix to all manuals.
#pdf_appendices = []
# Enable experimental feature to split table cells. Use it
# if you get "DelayedTable too big" errors
#pdf_splittables = False
# Set the default DPI for images
#pdf_default_dpi = 72
# Enable rst2pdf extension modules (default is only vectorpdf)
# you need vectorpdf if you want to use sphinx's graphviz support
#pdf_extensions = ['vectorpdf']
# Page template name for "regular" pages
# pdf_page_template = 'cutePage'
pdf_page_template = 'oneColumn'
# Show Table Of Contents at the beginning?
pdf_use_toc = True
# How many levels deep should the table of contents be?
pdf_toc_depth = 3
# Add section number to section references
#pdf_use_numbered_links = False
# Background images fitting mode
pdf_fit_background_mode = 'scale'
pdf_font_path = ['C:\\Windows\\Fonts\\', '/usr/share/fonts', '_fonts']
# -*- coding: utf-8 -*-
#
# "Fuel" documentation build configuration file, created by
# sphinx-quickstart on Tue Sep 25 14:02:29 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- 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.
#if on_rtd:
# extensions = ['sphinx.ext.autodoc','sphinxcontrib.plantuml']
# display_github = False
#else:
extensions = ['sphinx.ext.autodoc','rst2pdf.pdfbuilder','sphinxcontrib.plantuml']
#,'sphinxcontrib.fancybox']
plantuml = ['java','-jar','/sbin/plantuml.jar']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'contents'
# General information about the project.
project = u'Mirantis OpenStack'
copyright = u'2015, Mirantis Inc.'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '7.0'
# The full version, including alpha/beta/rc tags.
release = '7.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# exclude_patterns = ['_*', 'rn_index.rst']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- 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 = "mirantis"
# 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 = {
# Navigation bar title. (Default: ``project`` value)
'navbar_title': "Documentation",
# Tab name for entire site. (Default: "Site")
'navbar_site_name': "Guide",
# A list of tuples containing pages or urls to link to.
# Valid tuples should be in the following forms:
# (name, page) # a link to a page
# (name, "/aa/bb", 1) # a link to an arbitrary relative url
# (name, "http://example.com", True) # arbitrary absolute url
# Note the "1" or "True" value above as the third argument to indicate
# an arbitrary url.
# 'navbar_links': [
# ("Examples", "examples"),
# ("Link", "http://example.com", True),
# ],
# Render the next and previous page links in navbar. (Default: true)
'navbar_sidebarrel': True,
# Render the current pages TOC in the navbar. (Default: true)
'navbar_pagenav': True,
# Tab name for the current pages TOC. (Default: "Page")
'navbar_pagenav_name': "Section",
# Global TOC depth for "site" navbar tab. (Default: 1)
# Switching to -1 shows all levels.
'globaltoc_depth': 2,
# Include hidden TOCs in Site navbar?
#
# Note: If this is "false", you cannot have mixed ``:hidden:`` and
# non-hidden ``toctree`` directives in the same page, or else the build
# will break.
#
# Values: "true" (default) or "false"
'globaltoc_includehidden': "true",
# HTML navbar class (Default: "navbar") to attach to <div> element.
# For black navbar, do "navbar navbar-inverse"
'navbar_class': "navbar",
# Fix navigation bar to top of page?
# Values: "true" (default) or "false"
'navbar_fixed_top': "true",
# Location of link to source.
# Options are "nav" (default), "footer" or anything else to exclude.
'source_link_position': "nav",
# Bootswatch (http://bootswatch.com/) theme.
#
# Options are nothing (default) or the name of a valid theme
# such as "amelia" or "cosmo".
'bootswatch_theme': "yeti",
# Choose Bootstrap version.
# Values: "3" (default) or "2" (in quotes)
'bootstrap_version': "3",
}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_templates']
# html_add_permalinks = None
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = project + ' v' + release + ' | Documentation'
html_title = project + ' v' + release + ' | Documentation'
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '_static/mirantis_logo.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = '_static/mirantis_icon.ico'
# 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']
# html_extra_path = ['_templates/mirantis/static/index.html']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%c, %Z'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
html_use_smartypants = False
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {
# '**': ['searchbox.html', 'globaltoc.html'],
#}
html_sidebars = {
'**': ['globaltoc.html'],
}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
html_use_index = True
# If true, the index is split into individual pages for each letter.
html_split_index = False
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'fueldoc'
# -- 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': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
fuel = [
('install', 'install.tex', u'Fuel Installation Guide | Documentation',
u'Mirantis Inc.', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'fuel', u'Mirantis OpenStack | Documentation',
[u'Mirantis'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'fuel', u'Fuel for OpenStack | Documentation',
u'Mirantis Inc.', 'fuel', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# -- Additional Settings -------------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# extensions += ['sphinx.ext.inheritance_diagram', 'sphinxcontrib.blockdiag', 'sphinxcontrib.actdiag', 'sphinxcontrib.seqdiag', 'sphinxcontrib.nwdiag']
# The encoding of source files.
source_encoding = 'utf-8'
#source_encoding = 'shift_jis'
# The language for content autogenerated by Sphinx.
#language = 'en'
#language = 'ja'
# Enable Antialiasing
blockdiag_antialias = True
acttdiag_antialias = True
seqdiag_antialias = True
nwdiag_antialias = True
extensions += ['rst2pdf.pdfbuilder']
# pdf_documents = [
# (master_doc, project, project, copyright),
# ]
pdf_stylesheets = ['letter', 'mirantis']
pdf_style_path = ['_templates']
#pdf_language = "en"
# Mode for literal blocks wider than the frame. Can be
# overflow, shrink or truncate
pdf_fit_mode = "shrink"
# Section level that forces a break page.
# For example: 1 means top-level sections start in a new page
# 0 means disabled
pdf_break_level = 1
# When a section starts in a new page, force it to be 'even', 'odd',
# or just use 'any'
pdf_breakside = 'any'
# Insert footnotes where they are defined instead of
# at the end.
#pdf_inline_footnotes = True
# verbosity level. 0 1 or 2
pdf_verbosity = 0
# If false, no index is generated.
#pdf_use_index = True
# If false, no modindex is generated.
#pdf_use_modindex = False
# If false, no coverpage is generated.
# pdf_use_coverpage = False
# Name of the cover page template to use
pdf_cover_template = 'mirantiscover.tmpl'
# Documents to append as an appendix to all manuals.
#pdf_appendices = []
# Enable experimental feature to split table cells. Use it
# if you get "DelayedTable too big" errors
#pdf_splittables = False
# Set the default DPI for images
#pdf_default_dpi = 72
# Enable rst2pdf extension modules (default is only vectorpdf)
# you need vectorpdf if you want to use sphinx's graphviz support
#pdf_extensions = ['vectorpdf']
# Page template name for "regular" pages
# pdf_page_template = 'cutePage'
pdf_page_template = 'oneColumn'
# Show Table Of Contents at the beginning?
pdf_use_toc = True
# How many levels deep should the table of contents be?
pdf_toc_depth = 3
# Add section number to section references
#pdf_use_numbered_links = False
# Background images fitting mode
pdf_fit_background_mode = 'scale'
pdf_font_path = ['C:\\Windows\\Fonts\\', '/usr/share/fonts', '_fonts']

2
contents.rst
View File

@ -18,6 +18,4 @@ Documentation
plugin-dev
file-ref
release-notes
eula
third-party-licenses
fuel-install-guide

2
eula.rst
View File

@ -1,3 +1,5 @@
:orphan:
.. index:: Fuel License
============

2
index.rst
View File

@ -26,5 +26,3 @@ Mirantis OpenStack consists of the following components:
get support for Mirantis OpenStack from the industry experts.
For more information go to
https://www.mirantis.com/services/enterprise-support-services/
To view the HTML version of documentation, go to http://docs.mirantis.com

130
index_content.rst
View File

@ -1,130 +0,0 @@
:orphan:
.. index:: Home page
.. _Homepage:
PDF
~~~
`QuickStart Guide PDF <pdf/Mirantis-OpenStack-7.0-QuickStartGuide.pdf>`_
`Planning Guide PDF <pdf/Mirantis-OpenStack-7.0-PlanningGuide.pdf>`_
`User Guide PDF <pdf/Mirantis-OpenStack-7.0-UserGuide.pdf>`_
`Operations Guide PDF <pdf/Mirantis-OpenStack-7.0-OperationsGuide.pdf>`_
`Monitoring Guide PDF <pdf/Mirantis-OpenStack-7.0-MonitoringGuide.pdf>`_
`Reference Architectures PDF <pdf/Mirantis-OpenStack-7.0-ReferenceArchitecture.pdf>`_
`Fuel Plugin Guide PDF <pdf/Mirantis-OpenStack-7.0-FuelPluginGuide.pdf>`_
`Terminology Reference PDF <pdf/Mirantis-OpenStack-7.0-Terminology-Reference.pdf>`_
`File Format Reference PDF <pdf/Mirantis-OpenStack-7.0-File-Format-Reference.pdf>`_
`Release Notes PDF <pdf/Mirantis-OpenStack-7.0-RelNotes.pdf>`_
Guides
~~~~~~
`QuickStart Guide <quickstart-guide.html#quickstart-guide>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn how to install Mirantis OpenStack on VirtualBox.
`Planning Guide <planning-guide.html#planning-guide>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Explains how to plan Mirantis OpenStack deployment before installing
Fuel.
`User Guide <user-guide.html#user-guide>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Describes how to deploy and use Mirantis OpenStack environments
with Fuel.
`Operations Guide <operations.html#operations-guide>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Contains instructions on how to use and manage
your Mirantis OpenStack environment.
`Monitoring Guide <monitoring-guide.html#monitoring-guide>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Provides general concept on how to monitor OpenStack.
`Reference Architecture <reference-architecture.html#ref-arch>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Provides the deep dive into the structure of the Mirantis OpenStack environment,
network considerations, deployment options and architectures.
`Fuel Plugin Guide <plugin-dev.html#plugin-dev>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Explains how to develop and validate your own plugin for Fuel.
`Terminology Reference <terminology.html#terminology-ref>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Explains OpenStack terminology and technology
with references to other documentation and other useful information.
`File Format Reference <file-ref.html#file-ref>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Provides information on how to use Fuel configuration files.
`Release Notes <release-notes.html#release-notes>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Provide general information about new features,
fixed issues, and known limitations in Mirantis OpenStack |version|.
Prior releases
~~~~~~~~~~~~~~
`Mirantis OpenStack 6.1 <https://docs.mirantis.com/fuel/fuel-6.1/>`_
`Mirantis OpenStack 6.0 <https://docs.mirantis.com/fuel/fuel-6.0/>`_
`Mirantis OpenStack 5.1.1 <https://docs.mirantis.com/fuel/fuel-5.1/>`_
`Mirantis OpenStack 5.1 <https://docs.mirantis.com/fuel/fuel-5.1/>`_
`Mirantis OpenStack 5.0.1 <https://docs.mirantis.com/fuel/fuel-5.0/>`_
`Mirantis OpenStack 4.1 <https://docs.mirantis.com/fuel/fuel-4.1/>`_
`Mirantis OpenStack 4.0 <https://docs.mirantis.com/fuel/fuel-4.0/>`_
`Mirantis OpenStack 3.2 <https://docs.mirantis.com/fuel/fuel-3.2.1/>`_
`Fuel Web 3.0 <https://software.mirantis.com/refdoc-fuelweb3/video/>`_
`Fuel CLI 3.0 <https://software.mirantis.com/refdoc-fuel3/preface/>`_
`Fuel 2.1 <https://software.mirantis.com/reference-documentation-on-fuel-folsom-2-1/introduction-3/>`_
`Fuel 2.0 <https://software.mirantis.com/reference-documentation-on-fuel-folsom/package-contents-2/>`_
`Fuel 1.0 <https://software.mirantis.com/reference-documentation-on-fuel-essex/package-contents/>`_
`Download Now <http://software.mirantis.com/openstack-download-form>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can download the Mirantis OpenStack ISO and
`VirtualBox scripts <https://software.mirantis.com/load/7-0-vbox/>`_
.. note:: You must fill in the form to download Mirantis OpenStack.
`Demos and tutorials <https://www.youtube.com/watch?v=J5eG-UHOVfE>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Watch the Mirantis OpenStack demos at https://www.youtube.com/watch?v=ET4hkzb_QRM
.. container:: home-title
Mirantis OpenStack v7.0 Documentation
.. container:: what-is-mirantis-openstack
Mirantis OpenStack is made up of three components:
* :ref:`hardened-packages-term`.
Hardened packages in Mirantis OpenStack
include the core OpenStack projects,
updated with each stable release of OpenStack,
and supporting a broad range of operating systems,
hypervisors, and deployment topologies.
* :ref:`fuel-term`.
Fuel is an open source, software life cycle management application
that deploys multiple `OpenStack <https://www.openstack.org/>`_
environments from a single interface
and then enables you to manage those environments post deployment.
* `Support <https://www.mirantis.com/services/enterprise-support-services/>`_.
When you've completed your evaluation of Mirantis OpenStack,
`get support <https://www.mirantis.com/services/enterprise-support-services/>`_
for Mirantis OpenStack from the industry experts.
To read web version of Mirantis OpenStack documentation,
click `Guides <#guides>`_ tab.
To download pdf version, open
`Downloads <#downloads>`_ tab.

10
lunr.py
View File

@ -11,7 +11,7 @@ for remove in exclude:
doc = []
def formatheading(filename, headings, guide, type):
def formatheading(filename, link, headings, guide, type):
title = headings.text[:-1]
parent = headings.parent
url = filename + '#' + headings.parent.attrs['id']
@ -22,6 +22,7 @@ def formatheading(filename, headings, guide, type):
for tag in parent.find_all('h3'):
tag.parent.replaceWith('')
else:
url = filename + '#' + link
for tag in parent.find_all('h3'):
tag.replaceWith('')
for tag in parent.find_all('h4'):
@ -45,12 +46,15 @@ for file in files:
guide = title.text[:-1]
for headings in h3.findAll('h3'):
result = formatheading(filename, headings, guide, 'h3')
parent = headings.parent
parenth3 = parent.parent.findAll('h2')
link = parenth3[0].parent.attrs['id']
result = formatheading(filename, link, headings, guide, 'h3')
if result['body']:
doc.append(result)
for headings in h2.findAll('h2'):
result = formatheading(filename, headings, guide, 'h2')
result = formatheading(filename, '', headings, guide, 'h2')
if result['body']:
doc.append(result)

48
pdfs.rst Normal file
View File

@ -0,0 +1,48 @@
:orphan:
.. index:: PDFs
.. _PDFs:
================================================
Download Mirantis OpenStack Documentation PDFs
================================================
PDFs
----
The following Mirantis OpenStack documentation is available in PDF:
* `Planning Guide <pdf/Mirantis-OpenStack-5.0.1-PlanningGuide.pdf>`_
Planning information you should consider before
installing Fuel and deploying Mirantis OpenStack.
.. * `Installation Guide <pdf/Mirantis-OpenStack-7.0-InstallGuide.pdf>`_
This document describes how to pre-configure your
OpenStack environment and install the Fuel Master Node.
* `User Guide <pdf/Mirantis-OpenStack-7.0-UserGuide.pdf>`_
This document describes how to deploy Mirantis OpenStack environments
using Fuel.
* `Operations Guide <pdf/Mirantis-OpenStack-7.0-OperationsGuide.pdf>`_
A collection of useful procedures for using and managing
your Mirantis OpenStack environment.
* `Reference Architecture <pdf/Mirantis-OpenStack-7.0-ReferenceArchitecture.pdf>`_
A deep dive into the structure of the Mirantis OpenStack environment,
network considerations, and deployment options.
* `Terminology Reference <pdf/Mirantis-OpenStack-7.0-Terminology-Reference.pdf>`_
Short articles about OpenStack terminology and technology
with references to other documentation and other useful information.
* `Release Notes 5.0.1 <pdf/Mirantis-OpenStack-7.0-RelNotes.pdf>`_
The Release Notes provide general information about new features,
fixed issues, and known limitations in Mirantis OpenStack |version|.

16
third-party-licenses.rst
View File

@ -1,16 +0,0 @@
.. index:: Third-Party Components Licenses
===============================
Third-Party Components Licenses
===============================
Mirantis OpenStack includes a number of third-party open source components:
`DEB Packages Licenses <http://docs.mirantis.com/openstack/fuel/fuel-6.0/pdf/Mirantis-OpenStack-6.0-DEB-packages-licenses.pdf>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`RPM Packages Licenses <http://docs.mirantis.com/openstack/fuel/fuel-6.0/pdf/Mirantis-OpenStack-6.0-RPM-packages-licenses.pdf>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`JavaScript Libraries Licenses <http://docs.mirantis.com/openstack/fuel/fuel-6.0/pdf/Mirantis-OpenStack-6.0-JS-libraries-licenses.pdf>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~