Browse Source

Updated.

master
Alexander Thaller 1 year ago
parent
commit
dfb9e7b062

+ 100
- 3
_book/Docs/Structure.html View File

@@ -164,9 +164,9 @@
</li>
<li class="chapter " data-level="1.4" data-path="../lints.html">
<li class="chapter " data-level="1.4" data-path="../lints/">
<a href="../lints.html">
<a href="../lints/">
Lints
@@ -175,6 +175,103 @@

<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../lints/formula_has_no_init_file/">
<a href="../lints/formula_has_no_init_file/">
formula_has_no_init_file
</a>

</li>
<li class="chapter " data-level="1.4.2" data-path="../lints/formula_has_no_map_jinja_file/">
<a href="../lints/formula_has_no_map_jinja_file/">
formula_has_no_map_jinja_file
</a>

</li>
<li class="chapter " data-level="1.4.3" data-path="../lints/formula_has_no_pillar_example/">
<a href="../lints/formula_has_no_pillar_example/">
formula_has_no_pillar_example
</a>

</li>
<li class="chapter " data-level="1.4.4" data-path="../lints/readme_missing/">
<a href="../lints/readme_missing/">
readme_missing
</a>

</li>
<li class="chapter " data-level="1.4.5" data-path="../lints/readme_wrong_title/">
<a href="../lints/readme_wrong_title/">
readme_wrong_title
</a>

</li>
<li class="chapter " data-level="1.4.6" data-path="../lints/realm_is_not_documented/">
<a href="../lints/realm_is_not_documented/">
realm_is_not_documented
</a>

</li>
<li class="chapter " data-level="1.4.7" data-path="../lints/role_missing_metadata/">
<a href="../lints/role_missing_metadata/">
role_missing_metadata
</a>

</li>

</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../states/formula/README.md">
@@ -1448,7 +1545,7 @@ our pillars reside that are not included in the normal repository.</p>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Structure","level":"1.3.1","depth":2,"next":{"title":"Tools","level":"1.3.2","depth":2,"path":"Docs/Tools.md","ref":"Docs/Tools.md","articles":[]},"previous":{"title":"Docs","level":"1.3","depth":1,"path":"Docs/README.md","ref":"Docs/README.md","articles":[{"title":"Structure","level":"1.3.1","depth":2,"path":"Docs/Structure.adoc","ref":"Docs/Structure.adoc","articles":[]},{"title":"Tools","level":"1.3.2","depth":2,"path":"Docs/Tools.md","ref":"Docs/Tools.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"Docs/Structure.adoc","mtime":"2018-09-20T17:00:07.172Z","type":"asciidoc"},"gitbook":{"version":"3.2.3","time":"2018-09-20T17:00:26.104Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Structure","level":"1.3.1","depth":2,"next":{"title":"Tools","level":"1.3.2","depth":2,"path":"Docs/Tools.md","ref":"Docs/Tools.md","articles":[]},"previous":{"title":"Docs","level":"1.3","depth":1,"path":"Docs/README.md","ref":"Docs/README.md","articles":[{"title":"Structure","level":"1.3.1","depth":2,"path":"Docs/Structure.adoc","ref":"Docs/Structure.adoc","articles":[]},{"title":"Tools","level":"1.3.2","depth":2,"path":"Docs/Tools.md","ref":"Docs/Tools.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"Docs/Structure.adoc","mtime":"2018-09-25T09:07:14.402Z","type":"asciidoc"},"gitbook":{"version":"3.2.3","time":"2018-09-25T09:07:34.813Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>

+ 102
- 5
_book/Docs/Tools.html View File

@@ -61,7 +61,7 @@
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">

<link rel="next" href="../lints.html" />
<link rel="next" href="../lints/" />
<link rel="prev" href="Structure.html" />
@@ -164,9 +164,9 @@
</li>
<li class="chapter " data-level="1.4" data-path="../lints.html">
<li class="chapter " data-level="1.4" data-path="../lints/">
<a href="../lints.html">
<a href="../lints/">
Lints
@@ -175,6 +175,103 @@

<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../lints/formula_has_no_init_file/">
<a href="../lints/formula_has_no_init_file/">
formula_has_no_init_file
</a>

</li>
<li class="chapter " data-level="1.4.2" data-path="../lints/formula_has_no_map_jinja_file/">
<a href="../lints/formula_has_no_map_jinja_file/">
formula_has_no_map_jinja_file
</a>

</li>
<li class="chapter " data-level="1.4.3" data-path="../lints/formula_has_no_pillar_example/">
<a href="../lints/formula_has_no_pillar_example/">
formula_has_no_pillar_example
</a>

</li>
<li class="chapter " data-level="1.4.4" data-path="../lints/readme_missing/">
<a href="../lints/readme_missing/">
readme_missing
</a>

</li>
<li class="chapter " data-level="1.4.5" data-path="../lints/readme_wrong_title/">
<a href="../lints/readme_wrong_title/">
readme_wrong_title
</a>

</li>
<li class="chapter " data-level="1.4.6" data-path="../lints/realm_is_not_documented/">
<a href="../lints/realm_is_not_documented/">
realm_is_not_documented
</a>

</li>
<li class="chapter " data-level="1.4.7" data-path="../lints/role_missing_metadata/">
<a href="../lints/role_missing_metadata/">
role_missing_metadata
</a>

</li>

</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../states/formula/README.md">
@@ -321,7 +418,7 @@
</a>
<a href="../lints.html" class="navigation navigation-next " aria-label="Next page: Lints">
<a href="../lints/" class="navigation navigation-next " aria-label="Next page: Lints">
<i class="fa fa-angle-right"></i>
</a>
@@ -332,7 +429,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Tools","level":"1.3.2","depth":2,"next":{"title":"Lints","level":"1.4","depth":1,"path":"lints.adoc","ref":"lints.adoc","articles":[]},"previous":{"title":"Structure","level":"1.3.1","depth":2,"path":"Docs/Structure.adoc","ref":"Docs/Structure.adoc","articles":[]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"Docs/Tools.md","mtime":"2018-09-20T17:00:07.172Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-20T17:00:26.104Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Tools","level":"1.3.2","depth":2,"next":{"title":"Lints","level":"1.4","depth":1,"path":"lints/README.md","ref":"lints/README.md","articles":[{"title":"formula_has_no_init_file","level":"1.4.1","depth":2,"path":"lints/formula_has_no_init_file/README.adoc","ref":"lints/formula_has_no_init_file/README.adoc","articles":[]},{"title":"formula_has_no_map_jinja_file","level":"1.4.2","depth":2,"path":"lints/formula_has_no_map_jinja_file/README.adoc","ref":"lints/formula_has_no_map_jinja_file/README.adoc","articles":[]},{"title":"formula_has_no_pillar_example","level":"1.4.3","depth":2,"path":"lints/formula_has_no_pillar_example/README.adoc","ref":"lints/formula_has_no_pillar_example/README.adoc","articles":[]},{"title":"readme_missing","level":"1.4.4","depth":2,"path":"lints/readme_missing/README.adoc","ref":"lints/readme_missing/README.adoc","articles":[]},{"title":"readme_wrong_title","level":"1.4.5","depth":2,"path":"lints/readme_wrong_title/README.adoc","ref":"lints/readme_wrong_title/README.adoc","articles":[]},{"title":"realm_is_not_documented","level":"1.4.6","depth":2,"path":"lints/realm_is_not_documented/README.adoc","ref":"lints/realm_is_not_documented/README.adoc","articles":[]},{"title":"role_missing_metadata","level":"1.4.7","depth":2,"path":"lints/role_missing_metadata/README.adoc","ref":"lints/role_missing_metadata/README.adoc","articles":[]}]},"previous":{"title":"Structure","level":"1.3.1","depth":2,"path":"Docs/Structure.adoc","ref":"Docs/Structure.adoc","articles":[]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"Docs/Tools.md","mtime":"2018-09-25T09:07:14.402Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-25T09:07:34.813Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>

+ 100
- 3
_book/index.html View File

@@ -162,9 +162,9 @@
</li>
<li class="chapter " data-level="1.4" data-path="lints.html">
<li class="chapter " data-level="1.4" data-path="lints/">
<a href="lints.html">
<a href="lints/">
Lints
@@ -173,6 +173,103 @@

<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="lints/formula_has_no_init_file/">
<a href="lints/formula_has_no_init_file/">
formula_has_no_init_file
</a>

</li>
<li class="chapter " data-level="1.4.2" data-path="lints/formula_has_no_map_jinja_file/">
<a href="lints/formula_has_no_map_jinja_file/">
formula_has_no_map_jinja_file
</a>

</li>
<li class="chapter " data-level="1.4.3" data-path="lints/formula_has_no_pillar_example/">
<a href="lints/formula_has_no_pillar_example/">
formula_has_no_pillar_example
</a>

</li>
<li class="chapter " data-level="1.4.4" data-path="lints/readme_missing/">
<a href="lints/readme_missing/">
readme_missing
</a>

</li>
<li class="chapter " data-level="1.4.5" data-path="lints/readme_wrong_title/">
<a href="lints/readme_wrong_title/">
readme_wrong_title
</a>

</li>
<li class="chapter " data-level="1.4.6" data-path="lints/realm_is_not_documented/">
<a href="lints/realm_is_not_documented/">
realm_is_not_documented
</a>

</li>
<li class="chapter " data-level="1.4.7" data-path="lints/role_missing_metadata/">
<a href="lints/role_missing_metadata/">
role_missing_metadata
</a>

</li>

</ul>
</li>
<li class="chapter " data-level="1.5" data-path="states/formula/README.md">
@@ -329,7 +426,7 @@ SaltConf17</a>.</p>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Realms","level":"1.2","depth":1,"path":"realms.adoc","ref":"realms.adoc","articles":[]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"README.md","mtime":"2018-09-20T17:00:07.172Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-20T17:00:26.104Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Realms","level":"1.2","depth":1,"path":"realms.adoc","ref":"realms.adoc","articles":[]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"README.md","mtime":"2018-09-25T09:07:14.402Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-25T09:07:34.813Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>

+ 0
- 870
_book/lints.html View File

@@ -1,870 +0,0 @@

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Lints · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="gitbook/style.css">

<link rel="stylesheet" href="gitbook/gitbook-plugin-page-toc/page-toc.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">



<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">

<link rel="next" href="states/formula/README.md" />
<link rel="prev" href="Docs/Tools.html" />

</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>

<nav role="navigation">


<ul class="summary">


<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>

</li>
<li class="chapter " data-level="1.2" data-path="realms.html">
<a href="realms.html">
Realms
</a>

</li>
<li class="chapter " data-level="1.3" data-path="Docs/README.md">
<span>
Docs
</a>

<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="Docs/Structure.html">
<a href="Docs/Structure.html">
Structure
</a>

</li>
<li class="chapter " data-level="1.3.2" data-path="Docs/Tools.html">
<a href="Docs/Tools.html">
Tools
</a>

</li>

</ul>
</li>
<li class="chapter active" data-level="1.4" data-path="lints.html">
<a href="lints.html">
Lints
</a>

</li>
<li class="chapter " data-level="1.5" data-path="states/formula/README.md">
<span>
Formulas
</a>

</li>
<li class="chapter " data-level="1.6" data-path="states/profile/README.md">
<span>
Profiles
</a>

</li>
<li class="chapter " data-level="1.7" data-path="roles/README.md">
<span>
Roles
</a>

<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="roles/ssl_terminator/">
<a href="roles/ssl_terminator/">
ssl_terminator
</a>

</li>

</ul>
</li>


<li class="divider"></li>

<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>


</nav>
</div>

<div class="book-body">
<div class="body-inner">

<div class="book-header" role="navigation">

<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Lints</a>
</h1>
</div>




<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="lints">Lints</h1>
<div class="sect1">
<h2 id="_formula_has_no_init_file">formula_has_no_init_file</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Usability</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Warning</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="_what_it_does">What It Does</h3>
<div class="paragraph">
<p>Checks in all the v2 formula folders if the file <code>formula_folder/init.sls</code> exists.</p>
</div>
</div>
<div class="sect2">
<h3 id="_why_is_this_bad">Why Is This Bad</h3>
<div class="paragraph">
<p>Normally our formulas have an <code>init.sls</code> file as an entry point when using the formula. When that is not the case the user/developer of that formula should be informed in some way to make it less confusing why the <code>init.sls</code> is not used.</p>
</div>
</div>
<div class="sect2">
<h3 id="_how_to_fix">How To Fix</h3>
<div class="paragraph">
<p>If the formula does not use or need an <code>init.sls</code> file and is used in a
different way a <code>init.sls</code> file should be created that states with the formula
does not need a <code>init.sls</code>.</p>
</div>
<div class="listingblock">
<div class="title">Example <code>init.sls</code> from <code>formula.helper_scripts</code></div>
<div class="content">
<pre class="highlight"><code class="language-yaml" data-lang="yaml"><span class="hljs-comment"># The scripts are directly used with cmd.script and don&apos;t require state files.</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_known_problems">Known Problems</h3>
<div class="paragraph">
<p>None</p>
</div>
</div>
<div class="sect2">
<h3 id="_example">Example</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-filesystem" data-lang="filesystem">&#xBB; tree states/formula/helper_scripts
states/formula/helper_scripts
&#x251C;&#x2500;&#x2500; fix_user
&#x251C;&#x2500;&#x2500; map.jinja
&#x251C;&#x2500;&#x2500; pillar.example
&#x2514;&#x2500;&#x2500; README.md

0 directories, 4 files</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-lintoutput" data-lang="lintoutput">warning: formula `formula.helper_scripts` does not have a init.sls file at the expected path
quickfix: create a file under &quot;/home/athaller/code/work/salt/saltstack/states/formula/helper_scripts/init.sls&quot; that states why this formula does not need a init.sls file</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_formula_has_no_map_jinja_file">formula_has_no_map_jinja_file</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Usability</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Warning</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="_what_it_does_2">What It Does</h3>
<div class="paragraph">
<p>Checks in all the v2 formula folders if the file <code>formula_folder/map.jinja</code> exists.</p>
</div>
</div>
<div class="sect2">
<h3 id="_why_is_this_bad_2">Why Is This Bad</h3>
<div class="paragraph">
<p>Normally our formulas have an <code>map.jinja</code> file as an entry point when using the formula. When that is not the case the user/developer of that formula should be informed in some way to make it less confusing why the <code>map.jinja</code> is not used.</p>
</div>
</div>
<div class="sect2">
<h3 id="_how_to_fix_2">How To Fix</h3>
<div class="paragraph">
<p>If the formula does not use or need an <code>map.jinja</code> file a <code>map.jinja</code> file
should be created that states with the formula does not need a <code>map.jinja</code>.</p>
</div>
<div class="listingblock">
<div class="title">Example <code>map.jinja</code> from <code>formula.helper_scripts</code></div>
<div class="content">
<pre class="highlight"><code class="language-jinja" data-lang="jinja"><span class="xml"></span><span class="hljs-comment">{# The scripts are directly used with cmd.script and don&apos;t require state files. #}</span><span class="xml"></span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_known_problems_2">Known Problems</h3>
<div class="paragraph">
<p>None</p>
</div>
</div>
<div class="sect2">
<h3 id="_example_2">Example</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-filesystem" data-lang="filesystem">&#xBB; tree states/formula/helper_scripts
states/formula/helper_scripts
&#x251C;&#x2500;&#x2500; fix_user
&#x251C;&#x2500;&#x2500; init.sls
&#x251C;&#x2500;&#x2500; pillar.example
&#x2514;&#x2500;&#x2500; README.md

0 directories, 4 files</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-lintoutput" data-lang="lintoutput">warning: formula `formula.helper_scripts` does not have a map.jinja file at the expected path
quickfix: create an empty file under &quot;/home/athaller/code/work/salt/saltstack/states/formula/helper_scripts/map.jinja&quot; and state why this formula does not need a map.jinja file</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_formula_has_no_pillar_example">formula_has_no_pillar_example</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Usability</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Warning</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="_what_it_does_3">What It Does</h3>
<div class="paragraph">
<p>Checks in all the v2 formula folders if the file <code>formula_folder/pillar.example</code> exists.</p>
</div>
</div>
<div class="sect2">
<h3 id="_why_is_this_bad_3">Why Is This Bad</h3>
<div class="paragraph">
<p>Formulas without a <code>pillar.example</code> file are hard to use. The primary interface between users and the formula are pillars. If there is no example of how to use the formula the user will be lost.</p>
</div>
</div>
<div class="sect2">
<h3 id="_how_to_fix_3">How To Fix</h3>
<div class="paragraph">
<p>If the formula is not configurable via the pillars and empty pillar.example file
should be created.</p>
</div>
<div class="paragraph">
<p>If the formula is configurable via the pillars a file with a good example should
be created. Alternatively default values from the <code>map.jinja</code> should be
recreated in the <code>pillar.example</code> file.</p>
</div>
<div class="listingblock">
<div class="title">Example <code>pillar.example</code> from <code>formula.helper_scripts</code></div>
<div class="content">
<pre class="highlight"><code class="language-yaml" data-lang="yaml"><span class="hljs-comment"># No state files required so also no pillars required</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_known_problems_3">Known Problems</h3>
<div class="paragraph">
<p>None</p>
</div>
</div>
<div class="sect2">
<h3 id="_example_3">Example</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-filesystem" data-lang="filesystem">&#xBB; tree states/formula/helper_scripts
states/formula/helper_scripts
&#x251C;&#x2500;&#x2500; fix_user
&#x251C;&#x2500;&#x2500; init.sls
&#x251C;&#x2500;&#x2500; map.jinja
&#x2514;&#x2500;&#x2500; README.md

0 directories, 4 files</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-lintoutput" data-lang="lintoutput">warning: formula `formula.helper_scripts` does not have a pillar.example file at the expected path
quickfix: create an empty file under &quot;/home/athaller/code/work/salt/saltstack/states/formula/helper_scripts/pillar.example&quot; if there are no valid example pillars or find good examples for the formula</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_readme_missing">readme_missing</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Documentation</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Error</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="_what_it_does_4">What It Does</h3>
<div class="paragraph">
<p>Checks all v2 formulas and profiles if the <code>README.md</code> file exists.</p>
</div>
</div>
<div class="sect2">
<h3 id="_why_is_this_bad_4">Why Is This Bad</h3>
<div class="paragraph">
<p>For documentation purposes formulas and profiles should have a <code>README.md</code> to make it easier to figure out what the purpose of the state is.</p>
</div>
</div>
<div class="sect2">
<h3 id="_how_to_fix_4">How To Fix</h3>
<div class="paragraph">
<p>Create a new <code>README.md</code> file that has the state name as the first header and
then a short description of what the purpose of the state is.</p>
</div>
<div class="listingblock">
<div class="title">Example <code>README.md</code> from <code>formula.helper_scripts</code></div>
<div class="content">
<pre class="highlight"><code class="language-markdown" data-lang="markdown"><span class="hljs-section"># formula.helper_scripts</span>

A collection of usefull scripts that can be used with cmd.script.</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_known_problems_4">Known Problems</h3>
<div class="paragraph">
<p>None</p>
</div>
</div>
<div class="sect2">
<h3 id="_example_4">Example</h3>
<div class="listingblock">
<div class="content">
<pre>states/formula/helper_scripts
&#x251C;&#x2500;&#x2500; fix_user
&#x251C;&#x2500;&#x2500; init.sls
&#x251C;&#x2500;&#x2500; map.jinja
&#x2514;&#x2500;&#x2500; pillar.example

0 directories, 4 files</pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-lintoutput" data-lang="lintoutput">warning: formula `formula.helper_scripts` does not have a README.md file at the expected path
quickfix: create an file under &quot;/home/athaller/code/work/salt/saltstack/states/formula/helper_scripts/README.md&quot; that at least contains the name of the formula as a first markdown header</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_readme_wrong_title">readme_wrong_title</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Style</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Warning</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="_what_it_does_5">What It Does</h3>
<div class="paragraph">
<p>Checks that the first line in the <code>README.md</code> contains the symbol for title at the beginning followed by <code>$STATE_TYPE.$FORMULA_NAME</code>.</p>
</div>
</div>
<div class="sect2">
<h3 id="_why_is_this_bad_5">Why Is This Bad</h3>
<div class="paragraph">
<p>Wrongly named readmes can be confusing and can look weird in the documentation.</p>
</div>
</div>
<div class="sect2">
<h3 id="_how_to_fix_5">How To Fix</h3>
<div class="paragraph">
<p>Put a correctly formatted line as the first line of the readme that is affected.</p>
</div>
</div>
<div class="sect2">
<h3 id="_known_problems_5">Known Problems</h3>
<div class="paragraph">
<p>None</p>
</div>
</div>
<div class="sect2">
<h3 id="_example_5">Example</h3>
<div class="paragraph">
<p>Example <code>README.md</code> from <code>formula.nginx</code></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-markdown" data-lang="markdown"><span class="hljs-section"># formula.not_nginx</span>

Manage nginx webserver.</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-lintoutput" data-lang="lintoutput">error: README.md of formula `formula.nginx` does not start with formula name heading
file: &quot;states/formula/nginx/README.md&quot;
line: 1:1 to 22:1
quickfix: put `# formula.nginx` as first line in file &quot;states/formula/nginx/README.md&quot;
category: Style
help: for more information see https://share.thaller.ws/sk43iJjWGQoypYQB2JtopK5KnLwa9u/index.html#formula_readme_wrong_title</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_realm_is_not_documented">realm_is_not_documented</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Documentation</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Error</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="_what_it_does_6">What It Does</h3>
<div class="paragraph">
<p>Checks if all realms in the repository are documented in <code>docs/v2/metadata.yaml</code>.</p>
</div>
</div>
<div class="sect2">
<h3 id="_why_is_this_bad_6">Why Is This Bad</h3>
<div class="paragraph">
<p>It can be hard to understand the purpose of certain realms and when to use them. Documentation explains what they are for and make it easier to pick the right realm.</p>
</div>
</div>
<div class="sect2">
<h3 id="_how_to_fix_6">How To Fix</h3>
<div class="dlist">
<dl>
<dt class="hdlist1">Example Realm</dt>
<dd>
<p><code>datacenter.example_realm</code></p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>Add an entry in <code>docs/v2/metadata.yaml</code> that looks like this:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-yaml" data-lang="yaml"><span class="hljs-attr">realms:</span>
<span class="hljs-attr"> datacenter:</span>
<span class="hljs-attr"> description:</span> <span class="hljs-string">&apos;The datacenter realm contains all our datacenters as subrealms.&apos;</span>

<span class="hljs-attr"> subrealms:</span>
<span class="hljs-attr"> example_realm:</span>
<span class="hljs-attr"> description:</span> <span class="hljs-string">&gt;
An example realm to show how to fix the lint regarding undocumented
realms.</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_known_problems_6">Known Problems</h3>
<div class="paragraph">
<p>None</p>
</div>
</div>
<div class="sect2">
<h3 id="_example_6">Example</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-lintoutput" data-lang="lintoutput">error: realm `testing.saltmaster_ide.nebula.dg` is not documented in metadata file
file: &quot;pillars/global/realm/testing/saltmaster_ide/nebula/dg/init.sls&quot;
quickfix: create an entry in &quot;/home/athaller/code/work/salt/saltstack/docs/v2/metadata.yaml&quot; for the realm testing.saltmaster_ide.nebula.dg
category: Documentation
help: for more information see https://share.thaller.ws/sk43iJjWGQoypYQB2JtopK5KnLwa9u/index.html#realm_is_not_documented</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_role_missing_metadata">role_missing_metadata</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Documentation</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Error</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="_what_it_does_7">What It Does</h3>
<div class="paragraph">
<p>Checks all v2 roles if the metadata file is present.</p>
</div>
</div>
<div class="sect2">
<h3 id="_why_is_this_bad_7">Why Is This Bad</h3>
<div class="paragraph">
<p>For documentation purposes the metadata file should be present.</p>
</div>
</div>
<div class="sect2">
<h3 id="_how_to_fix_7">How To Fix</h3>
<div class="paragraph">
<p>Create a <code>metadata.yaml</code> file in the role folder with the content specified in <a href="http://saltdocs.tcs.trv.cloud/master/docs/rfcs/salt1-role_metadata.html" class="bare" target="_blank">http://saltdocs.tcs.trv.cloud/master/docs/rfcs/salt1-role_metadata.html</a>.</p>
</div>
<div class="listingblock">
<div class="title">Example <code>metadata.yaml</code> from <code>role.loadbalancer_datacenter</code></div>
<div class="content">
<pre class="highlight"><code class="language-yaml" data-lang="yaml"><span class="hljs-attr">name:</span> loadbalancer_datacenter
<span class="hljs-attr">description:</span> Role for the loadbalancers in SFO, DCA and HKG. They take HTTP
traffic and route/forward them to the webservers and take HTTPs traffic and
forward them to the `ssl_terminators`.
<span class="hljs-attr">maintainers:</span>
<span class="hljs-bullet"> -</span> alexander.thaller@trivago.com
<span class="hljs-bullet"> -</span> florian.kruschel@trivago.com
<span class="hljs-bullet"> -</span> marc.peters@trivago.com</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_known_problems_7">Known Problems</h3>
<div class="paragraph">
<p>None</p>
</div>
</div>
<div class="sect2">
<h3 id="_example_7">Example</h3>
<div class="listingblock">
<div class="content">
<pre>states/role/elasticsearch_master
&#x2514;&#x2500;&#x2500; init.sls

0 directories, 1 file

[source,lintoutput]</pre>
</div>
</div>
<div class="paragraph">
<p>Error: role <code>elasticsearch_master</code> does not have a metadata file at the expected path
file: &quot;/home/athaller/code/work/salt/saltstack/states/role/elasticsearch_master/metadata.yaml&quot;
quickfix: create an file under &quot;/home/athaller/code/work/salt/saltstack/states/role/elasticsearch_master/metadata.yaml&quot; specified in <a href="http://saltdocs.tcs.trv.cloud/master/docs/rfcs/salt1-role_metadata.html" class="bare" target="_blank">http://saltdocs.tcs.trv.cloud/master/docs/rfcs/salt1-role_metadata.html</a>
category: Documentation
help: for more information see <a href="http://saltdocs.tcs.trv.cloud/master/lints.html#_role_missing_metadata" class="bare" target="_blank">http://saltdocs.tcs.trv.cloud/master/lints.html#_role_missing_metadata</a></p>
</div>
<div class="listingblock">
<div class="content">
<pre></pre>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>

</div>
</div>
</div>

<a href="Docs/Tools.html" class="navigation navigation-prev " aria-label="Previous page: Tools">
<i class="fa fa-angle-left"></i>
</a>
<a href="states/formula/README.md" class="navigation navigation-next " aria-label="Next page: Formulas">
<i class="fa fa-angle-right"></i>
</a>
</div>

<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Lints","level":"1.4","depth":1,"next":{"title":"Formulas","level":"1.5","depth":1,"path":"states/formula/README.md","ref":"states/formula/README.md","articles":[]},"previous":{"title":"Tools","level":"1.3.2","depth":2,"path":"Docs/Tools.md","ref":"Docs/Tools.md","articles":[]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"lints.adoc","mtime":"2018-09-20T17:00:07.172Z","type":"asciidoc"},"gitbook":{"version":"3.2.3","time":"2018-09-20T17:00:26.104Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>

<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-page-toc/anchor-3.1.1.min.js"></script>
<script src="gitbook/gitbook-plugin-page-toc/page-toc.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>

</body>
</html>


+ 546
- 0
_book/lints/formula_has_no_init_file/index.html View File

@@ -0,0 +1,546 @@

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>formula_has_no_init_file · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../../gitbook/style.css">

<link rel="stylesheet" href="../../gitbook/gitbook-plugin-page-toc/page-toc.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-fontsettings/website.css">



<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon">

<link rel="next" href="../formula_has_no_map_jinja_file/" />
<link rel="prev" href="../" />

</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>

<nav role="navigation">


<ul class="summary">


<li class="chapter " data-level="1.1" data-path="../../">
<a href="../../">
Introduction
</a>

</li>
<li class="chapter " data-level="1.2" data-path="../../realms.html">
<a href="../../realms.html">
Realms
</a>

</li>
<li class="chapter " data-level="1.3" data-path="../../Docs/README.md">
<span>
Docs
</a>

<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../../Docs/Structure.html">
<a href="../../Docs/Structure.html">
Structure
</a>

</li>
<li class="chapter " data-level="1.3.2" data-path="../../Docs/Tools.html">
<a href="../../Docs/Tools.html">
Tools
</a>

</li>

</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../">
<a href="../">
Lints
</a>

<ul class="articles">
<li class="chapter active" data-level="1.4.1" data-path="./">
<a href="./">
formula_has_no_init_file
</a>

</li>
<li class="chapter " data-level="1.4.2" data-path="../formula_has_no_map_jinja_file/">
<a href="../formula_has_no_map_jinja_file/">
formula_has_no_map_jinja_file
</a>

</li>
<li class="chapter " data-level="1.4.3" data-path="../formula_has_no_pillar_example/">
<a href="../formula_has_no_pillar_example/">
formula_has_no_pillar_example
</a>

</li>
<li class="chapter " data-level="1.4.4" data-path="../readme_missing/">
<a href="../readme_missing/">
readme_missing
</a>

</li>
<li class="chapter " data-level="1.4.5" data-path="../readme_wrong_title/">
<a href="../readme_wrong_title/">
readme_wrong_title
</a>

</li>
<li class="chapter " data-level="1.4.6" data-path="../realm_is_not_documented/">
<a href="../realm_is_not_documented/">
realm_is_not_documented
</a>

</li>
<li class="chapter " data-level="1.4.7" data-path="../role_missing_metadata/">
<a href="../role_missing_metadata/">
role_missing_metadata
</a>

</li>

</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../states/formula/README.md">
<span>
Formulas
</a>

</li>
<li class="chapter " data-level="1.6" data-path="../../states/profile/README.md">
<span>
Profiles
</a>

</li>
<li class="chapter " data-level="1.7" data-path="../../roles/README.md">
<span>
Roles
</a>

<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="../../roles/ssl_terminator/">
<a href="../../roles/ssl_terminator/">
ssl_terminator
</a>

</li>

</ul>
</li>


<li class="divider"></li>

<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>


</nav>
</div>

<div class="book-body">
<div class="body-inner">

<div class="book-header" role="navigation">

<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="../.." >formula_has_no_init_file</a>
</h1>
</div>




<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="formulahasnoinitfile">formula_has_no_init_file</h1>
<div id="preamble">
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">Category</dt>
<dd>
<p>Usability</p>
</dd>
<dt class="hdlist1">Severity</dt>
<dd>
<p>Warning</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_what_it_does">What It Does</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Checks in all the v2 formula folders if the file <code>formula_folder/init.sls</code> exists.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_why_is_this_bad">Why Is This Bad</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Normally our formulas have an <code>init.sls</code> file as an entry point when using the formula. When that is not the case the user/developer of that formula should be informed in some way to make it less confusing why the <code>init.sls</code> is not used.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_how_to_fix">How To Fix</h2>
<div class="sectionbody">
<div class="paragraph">
<p>If the formula does not use or need an <code>init.sls</code> file and is used in a
different way a <code>init.sls</code> file should be created that states with the formula
does not need a <code>init.sls</code>.</p>
</div>
<div class="listingblock">
<div class="title">Example <code>init.sls</code> from <code>formula.helper_scripts</code></div>
<div class="content">
<pre class="highlight"><code class="language-yaml" data-lang="yaml"><span class="hljs-comment"># The scripts are directly used with cmd.script and don&apos;t require state files.</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_known_problems">Known Problems</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_example">Example</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-filesystem" data-lang="filesystem">&#xBB; tree states/formula/helper_scripts
states/formula/helper_scripts
&#x251C;&#x2500;&#x2500; fix_user
&#x251C;&#x2500;&#x2500; map.jinja
&#x251C;&#x2500;&#x2500; pillar.example
&#x2514;&#x2500;&#x2500; README.md

0 directories, 4 files</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-lintoutput" data-lang="lintoutput">warning: formula `formula.helper_scripts` does not have a init.sls file at the expected path
quickfix: create a file under &quot;/home/athaller/code/work/salt/saltstack/states/formula/helper_scripts/init.sls&quot; that states why this formula does not need a init.sls file</code></pre>
</div>
</div>
</div>
</div>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>

</div>
</div>
</div>

<a href="../" class="navigation navigation-prev " aria-label="Previous page: Lints">
<i class="fa fa-angle-left"></i>
</a>
<a href="../formula_has_no_map_jinja_file/" class="navigation navigation-next " aria-label="Next page: formula_has_no_map_jinja_file">
<i class="fa fa-angle-right"></i>
</a>
</div>

<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"formula_has_no_init_file","level":"1.4.1","depth":2,"next":{"title":"formula_has_no_map_jinja_file","level":"1.4.2","depth":2,"path":"lints/formula_has_no_map_jinja_file/README.adoc","ref":"lints/formula_has_no_map_jinja_file/README.adoc","articles":[]},"previous":{"title":"Lints","level":"1.4","depth":1,"path":"lints/README.md","ref":"lints/README.md","articles":[{"title":"formula_has_no_init_file","level":"1.4.1","depth":2,"path":"lints/formula_has_no_init_file/README.adoc","ref":"lints/formula_has_no_init_file/README.adoc","articles":[]},{"title":"formula_has_no_map_jinja_file","level":"1.4.2","depth":2,"path":"lints/formula_has_no_map_jinja_file/README.adoc","ref":"lints/formula_has_no_map_jinja_file/README.adoc","articles":[]},{"title":"formula_has_no_pillar_example","level":"1.4.3","depth":2,"path":"lints/formula_has_no_pillar_example/README.adoc","ref":"lints/formula_has_no_pillar_example/README.adoc","articles":[]},{"title":"readme_missing","level":"1.4.4","depth":2,"path":"lints/readme_missing/README.adoc","ref":"lints/readme_missing/README.adoc","articles":[]},{"title":"readme_wrong_title","level":"1.4.5","depth":2,"path":"lints/readme_wrong_title/README.adoc","ref":"lints/readme_wrong_title/README.adoc","articles":[]},{"title":"realm_is_not_documented","level":"1.4.6","depth":2,"path":"lints/realm_is_not_documented/README.adoc","ref":"lints/realm_is_not_documented/README.adoc","articles":[]},{"title":"role_missing_metadata","level":"1.4.7","depth":2,"path":"lints/role_missing_metadata/README.adoc","ref":"lints/role_missing_metadata/README.adoc","articles":[]}]},"dir":"ltr"},"config":{"plugins":["page-toc"],"root":"./docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"position":"before-first","page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","showByDefault":true},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"3.2.3"},"file":{"path":"lints/formula_has_no_init_file/README.adoc","mtime":"2018-09-25T09:07:14.402Z","type":"asciidoc"},"gitbook":{"version":"3.2.3","time":"2018-09-25T09:07:34.813Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>

<script src="../../gitbook/gitbook.js"></script>
<script src="../../gitbook/theme.js"></script>
<script src="../../gitbook/gitbook-plugin-page-toc/anchor-3.1.1.min.js"></script>
<script src="../../gitbook/gitbook-plugin-page-toc/page-toc.js"></script>
<script src="../../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../../gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="../../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>

</body>
</html>


+ 545
- 0
_book/lints/formula_has_no_map_jinja_file/index.html View File

@@ -0,0 +1,545 @@

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>formula_has_no_map_jinja_file · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../../gitbook/style.css">

<link rel="stylesheet" href="../../gitbook/gitbook-plugin-page-toc/page-toc.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-fontsettings/website.css">



<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon">

<link rel="next" href="../formula_has_no_pillar_example/" />
<link rel="prev" href="../formula_has_no_init_file/" />

</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>

<nav role="navigation">


<ul class="summary">


<li class="chapter " data-level="1.1" data-path="../../">
<a href="../../">
Introduction
</a>

</li>
<li class="chapter " data-level="1.2" data-path="../../realms.html">
<a href="../../realms.html">
Realms
</a>

</li>
<li class="chapter " data-level="1.3" data-path="../../Docs/README.md">
<span>
Docs
</a>

<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../../Docs/Structure.html">
<a href="../../Docs/Structure.html">
Structure
</a>

</li>
<li class="chapter " data-level="1.3.2" data-path="../../Docs/Tools.html">
<a href="../../Docs/Tools.html">
Tools
</a>

</li>

</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../">
<a href="../">
Lints
</a>

<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../formula_has_no_init_file/">
<a href="../formula_has_no_init_file/">
formula_has_no_init_file
</a>

</li>
<li class="chapter active" data-level="1.4.2" data-path="./">
<a href="./">
formula_has_no_map_jinja_file
</a>

</li>
<li class="chapter " data-level="1.4.3" data-path="../formula_has_no_pillar_example/">
<a href="../formula_has_no_pillar_example/">
formula_has_no_pillar_example
</a>

</li>
<li class="chapter " data-level="1.4.4" data-path="../readme_missing/">
<a href="../readme_missing/">
readme_missing
</a>

</li>
<li class="chapter " data-level="1.4.5" data-path="../readme_wrong_title/">
<a href="../readme_wrong_title/">
readme_wrong_title
</a>

</li>
<li class="chapter " data-level="1.4.6" data-path="../realm_is_not_documented/">
<a href="../realm_is_not_documented/">
realm_is_not_documented
</a>