Merge pull request #611 from gravitl/feature_v0.9.4_docs

minor docs fixes
gravitl · Jan 16, 2022 · 44688fe · 44688fe
2 parents fce744b + 9159f2a
commit 44688fe
Show file tree

Hide file tree

Showing 15 changed files with 171 additions and 129 deletions.
diff --git a/docs/_build/doctrees/architecture.doctree b/docs/_build/doctrees/architecture.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/server-installation.doctree b/docs/_build/doctrees/server-installation.doctree
diff --git a/docs/_build/doctrees/ui-reference.doctree b/docs/_build/doctrees/ui-reference.doctree
diff --git a/docs/_build/html/_sources/architecture.rst.txt b/docs/_build/html/_sources/architecture.rst.txt
@@ -107,7 +107,7 @@ The check in process is what allows Netmaker to create dynamic mesh networks. As
 Database (sqlite, rqlite, postgres)
 -------------------------------------
 
-As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) databaseand. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users. 
+As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) database. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users. 
 
 Additional database support (besides sqlite and rqlite) is very easy to implement for special use cases. Netmaker uses simple key value lookups to run the networks, and the database was designed to be extensible, so support for key-value stores and other SQL-based databases can be achieved by changing a single file.
 

diff --git a/docs/_build/html/_sources/ui-reference.rst.txt b/docs/_build/html/_sources/ui-reference.rst.txt
@@ -42,8 +42,8 @@ Edit
 
 **NOTE:** With the exception of Address Ranges (1-2) any setting that affects nodes will not take effect on existing nodes. It will only set the settings on any **new** node, after the setting has been changed.
 
-(1) **Address Range (ipv4): The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.** 
-(2) **Address Range (ipv6): The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**
+(1) **Address Range (ipv4):** The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.** 
+(2) **Address Range (ipv6):** The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**
 (3) **Local Range:** Only relevant if "Is Local" was switched on during creation. Specifies the local range that nodes will base their Endpoint off of (note: if a node cannot find an enpoint within the range it will fallback to public ip).
 (4) **Display Name:** The display name of the network. Network Name cannot be changed (acts as a unique ID) but display name can be changed. Only effects appearance in UI.
 (5) **Default Interface:** The default network interface name configured on each node. This defaults to "nm-<network name>".

diff --git a/docs/_build/html/about.html b/docs/_build/html/about.html
@@ -285,49 +285,56 @@
  <li class="md-nav__item">
 
 
- <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
+ <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
+ <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="client-installation.html" class="md-nav__link">Client Installation</a>
+ <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
+ <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+ <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+ <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+
+
+ </li>
+ <li class="md-nav__item">
+
+
+ <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+ <a href="usage.html" class="md-nav__link">External Guides</a>
 
 
  </li>

diff --git a/docs/_build/html/architecture.html b/docs/_build/html/architecture.html
@@ -57,7 +57,7 @@
  <link rel="index" title="Index" href="genindex.html" />
  <link rel="search" title="Search" href="search.html" />
  <link rel="next" title="Install" href="install.html" />
- <link rel="prev" title="1. About" href="about.html" />
+ <link rel="prev" title="About" href="about.html" />
 
 
 
@@ -209,7 +209,7 @@
  <li class="md-nav__item">
 
 
- <a href="about.html" class="md-nav__link">1. About</a>
+ <a href="about.html" class="md-nav__link">About</a>
 
 
  </li>
@@ -329,49 +329,56 @@
  <li class="md-nav__item">
 
 
- <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
+ <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
+ <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="client-installation.html" class="md-nav__link">Client Installation</a>
+ <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="external-clients.html" class="md-nav__link">Ingress GW + External Clients</a>
+ <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+ <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+ <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+
+
+ </li>
+ <li class="md-nav__item">
+
+
+ <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
 
 
  </li>
  <li class="md-nav__item">
 
 
- <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+ <a href="usage.html" class="md-nav__link">External Guides</a>
 
 
  </li>
@@ -549,7 +556,7 @@ <h3 id="netclient">Netclient<a class="headerlink" href="#netclient" title="Perma
 
 
 <h3 id="database-sqlite-rqlite-postgres">Database (sqlite, rqlite, postgres)<a class="headerlink" href="#database-sqlite-rqlite-postgres" title="Permalink to this headline">¶</a></h3>
-<p>As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) databaseand. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users.</p>
+<p>As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) database. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users.</p>
 <p>Additional database support (besides sqlite and rqlite) is very easy to implement for special use cases. Netmaker uses simple key value lookups to run the networks, and the database was designed to be extensible, so support for key-value stores and other SQL-based databases can be achieved by changing a single file.</p>
 
 
@@ -640,7 +647,7 @@ <h2 id="limitations">Limitations<a class="headerlink" href="#limitations" title=
  <div class="md-footer-nav">
  <nav class="md-footer-nav__inner md-grid">
 
- <a href="about.html" title="1. About"
+ <a href="about.html" title="About"
  class="md-flex md-footer-nav__link md-footer-nav__link--prev"
  rel="prev">
  <div class="md-flex__cell md-flex__cell--shrink">
@@ -649,7 +656,7 @@ <h2 id="limitations">Limitations<a class="headerlink" href="#limitations" title=
  <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  <span class="md-flex__ellipsis">
  <span
- class="md-footer-nav__direction"> Previous </span> <span class="section-number">1. </span>About </span>
+ class="md-footer-nav__direction"> Previous </span> About </span>
  </div>
  </a>
 

diff --git a/docs/_build/html/external-clients.html b/docs/_build/html/external-clients.html
@@ -57,7 +57,7 @@
  <link rel="index" title="Index" href="genindex.html" />
  <link rel="search" title="Search" href="search.html" />
  <link rel="next" title="Egress Gateway" href="egress-gateway.html" />
- <link rel="prev" title="Client Installation" href="client-installation.html" />
+ <link rel="prev" title="Getting Started" href="getting-started.html" />
 
 
 
@@ -240,27 +240,6 @@
  <a href="getting-started.html" class="md-nav__link">Getting Started</a>
 
 
- </li>
- <li class="md-nav__item">
-
-
- <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
-
-
- </li>
- <li class="md-nav__item">
-
-
- <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
-
-
- </li>
- <li class="md-nav__item">
-
-
- <a href="client-installation.html" class="md-nav__link">Client Installation</a>
-
-
  </li>
  <li class="md-nav__item">
 
@@ -336,7 +315,35 @@
  <li class="md-nav__item">
 
 
- <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+ <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
+
+
+ </li>
+ <li class="md-nav__item">
+
+
+ <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
+
+
+ </li>
+ <li class="md-nav__item">
+
+
+ <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+
+
+ </li>
+ <li class="md-nav__item">
+
+
+ <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
+
+
+ </li>
+ <li class="md-nav__item">
+
+
+ <a href="usage.html" class="md-nav__link">External Guides</a>
 
 
  </li>
@@ -489,7 +496,7 @@ <h2 id="configuring-dns-for-ext-clients-optional">Configuring DNS for Ext Client
  <div class="md-footer-nav">
  <nav class="md-footer-nav__inner md-grid">
 
- <a href="client-installation.html" title="Client Installation"
+ <a href="getting-started.html" title="Getting Started"
  class="md-flex md-footer-nav__link md-footer-nav__link--prev"
  rel="prev">
  <div class="md-flex__cell md-flex__cell--shrink">
@@ -498,7 +505,7 @@ <h2 id="configuring-dns-for-ext-clients-optional">Configuring DNS for Ext Client
  <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  <span class="md-flex__ellipsis">
  <span
- class="md-footer-nav__direction"> Previous </span> Client Installation </span>
+ class="md-footer-nav__direction"> Previous </span> Getting Started </span>
  </div>
  </a>