Skip to content

Commit

Permalink
fix missing chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
stitch committed Jul 8, 2024
1 parent f2070e2 commit 3c43ab4
Show file tree
Hide file tree
Showing 34 changed files with 90 additions and 70 deletions.
12 changes: 6 additions & 6 deletions docs/input/1_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,11 @@ Use the following commands, of course with your own personal settings::
4. Setup the API credentials for the account.

1. Go to the account management page
2. ``http://127.0.0.1:8000/admin/internet_nl_dashboard/account/``
2. Click on the admin user
3. Setup the "internet nl api username" and "new password" field and click save
4. To test if the account was setup properly, use the 'Check API credentials'
5. If the credentials are correctly configured the check will return a checkmark symbol, otherwise a cross symbol will be visible on the row of this account.
2. http://127.0.0.1:8000/admin/internet_nl_dashboard/account/
3. Click on the admin user
4. Setup the "internet nl api username" and "new password" field and click save
5. To test if the account was setup properly, use the 'Check API credentials'
6. If the credentials are correctly configured the check will return a checkmark symbol, otherwise a cross symbol will be visible on the row of this account.

.. image:: installation/config_setup_api_credentials.png
.. image:: installation/config_credential_check.png
Expand Down Expand Up @@ -262,7 +262,7 @@ After a scan completes it's possible to receive an e-mail. An SMTP server has to

The e-mails that are being sent are stored as templates in the "📨 E-Mail Templates" section. The default language for
templates is English and several templates are pre-installed to be customized. For more information about these templates
check the :ref:`Email Templates` chapter.
check the :ref:`email templates` chapter.


.. rst-class:: page-break
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/input/3_email_templates.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _Email Templates:
.. _email templates:

.. sectnum::
:start: 3
Expand Down
Binary file modified docs/render/html/.doctrees/1_installation.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/render/html/.doctrees/3_email_templates.doctree
Binary file not shown.
Binary file modified docs/render/html/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/render/html/.doctrees/index.doctree
Binary file not shown.
19 changes: 10 additions & 9 deletions docs/render/html/1_installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="2. 3 Email Templates" href="3_email_templates.html" />
<link rel="next" title="2. 2 Dashboard User Management" href="2_user_management.html" />
<link rel="prev" title="internet.nl dashboard documentation" href="index.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />
Expand Down Expand Up @@ -158,12 +158,12 @@ <h3><span class="section-number">1.2.5. </span><span class="sectnum">1.2.5 </spa
<blockquote>
<div><ol class="arabic simple">
<li><p>Go to the account management page</p></li>
<li><p><a class="reference external" href="http://127.0.0.1:8000/admin/internet_nl_dashboard/account/">http://127.0.0.1:8000/admin/internet_nl_dashboard/account/</a></p></li>
<li><p>Click on the admin user</p></li>
<li><p>Setup the “internet nl api username” and “new password” field and click save</p></li>
<li><p>To test if the account was setup properly, use the ‘Check API credentials’</p></li>
<li><p>If the credentials are correctly configured the check will return a checkmark symbol, otherwise a cross symbol will be visible on the row of this account.</p></li>
</ol>
<p>2. <code class="docutils literal notranslate"><span class="pre">http://127.0.0.1:8000/admin/internet_nl_dashboard/account/</span></code>
2. Click on the admin user
3. Setup the “internet nl api username” and “new password” field and click save
4. To test if the account was setup properly, use the ‘Check API credentials’
5. If the credentials are correctly configured the check will return a checkmark symbol, otherwise a cross symbol will be visible on the row of this account.</p>
</div></blockquote>
<img alt="_images/config_setup_api_credentials.png" src="_images/config_setup_api_credentials.png" />
<img alt="_images/config_credential_check.png" src="_images/config_credential_check.png" />
Expand Down Expand Up @@ -232,7 +232,7 @@ <h3><span class="section-number">1.4.1. </span><span class="sectnum">1.4.1 </spa
<img alt="_images/email_configured_outbox.png" src="_images/email_configured_outbox.png" />
<p>The e-mails that are being sent are stored as templates in the “📨 E-Mail Templates” section. The default language for
templates is English and several templates are pre-installed to be customized. For more information about these templates
check the <span class="xref std std-ref">Email Templates</span> chapter.</p>
check the <span class="xref std std-ref">email templates</span> chapter.</p>
</section>
</section>
<section id="background-information">
Expand Down Expand Up @@ -285,15 +285,16 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="#background-information">1.5. <span class="sectnum">1.5 </span>Background information</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="3_email_templates.html">2. <span class="sectnum">3 </span>Email Templates</a></li>
<li class="toctree-l1"><a class="reference internal" href="2_user_management.html">2. <span class="sectnum">2 </span>Dashboard User Management</a></li>
<li class="toctree-l1"><a class="reference internal" href="3_email_templates.html">3. <span class="sectnum">3 </span>Email Templates</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">internet.nl dashboard documentation</a></li>
<li>Next: <a href="3_email_templates.html" title="next chapter"><span class="section-number">2. </span><span class="sectnum">3 </span>Email Templates</a></li>
<li>Next: <a href="2_user_management.html" title="next chapter"><span class="section-number">2. </span><span class="sectnum">2 </span>Dashboard User Management</a></li>
</ul></li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>2 Dashboard User Management &#8212; Internet.nl Dashboard documentation</title>
<title>2. 2 Dashboard User Management &#8212; Internet.nl Dashboard documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="3. 3 Email Templates" href="3_email_templates.html" />
<link rel="prev" title="1. 1 Installation guide" href="1_installation.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />

Expand All @@ -31,9 +33,9 @@
<div class="body" role="main">

<section id="dashboard-user-management">
<h1><span class="sectnum">2 </span>Dashboard User Management<a class="headerlink" href="#dashboard-user-management" title="Link to this heading"></a></h1>
<h1><span class="section-number">2. </span><span class="sectnum">2 </span>Dashboard User Management<a class="headerlink" href="#dashboard-user-management" title="Link to this heading"></a></h1>
<section id="overview">
<h2><span class="sectnum">2.1 </span>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h2>
<h2><span class="section-number">2.1. </span><span class="sectnum">2.1 </span>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h2>
<p>The dashboard knows of three places that have to do with users:</p>
<ul class="simple">
<li><p>The API User</p></li>
Expand All @@ -50,22 +52,22 @@ <h2><span class="sectnum">2.1 </span>Overview<a class="headerlink" href="#overvi
</ul>
<p>We know that ‘account’ and ‘user’ is ambiguous.</p>
<section id="abstract">
<h3><span class="sectnum">2.1.1 </span>Abstract<a class="headerlink" href="#abstract" title="Link to this heading"></a></h3>
<h3><span class="section-number">2.1.1. </span><span class="sectnum">2.1.1 </span>Abstract<a class="headerlink" href="#abstract" title="Link to this heading"></a></h3>
<img alt="_images/user_management_abstract.png" src="_images/user_management_abstract.png" />
</section>
<section id="in-practice">
<h3><span class="sectnum">2.1.2 </span>In practice<a class="headerlink" href="#in-practice" title="Link to this heading"></a></h3>
<h3><span class="section-number">2.1.2. </span><span class="sectnum">2.1.2 </span>In practice<a class="headerlink" href="#in-practice" title="Link to this heading"></a></h3>
<img alt="_images/user_management_in_practice.png" src="_images/user_management_in_practice.png" />
</section>
</section>
<section id="management">
<h2><span class="sectnum">2.2 </span>Management<a class="headerlink" href="#management" title="Link to this heading"></a></h2>
<h2><span class="section-number">2.2. </span><span class="sectnum">2.2 </span>Management<a class="headerlink" href="#management" title="Link to this heading"></a></h2>
<p>User and account management in the dashboard is done via the Dashboard app and the Django Admin Interface.
The latter is a bare bones data management application that allows editing data directly onto the database. The user
experience is good enough for system administrators that need ultimate power and flexibility. With great power comes
great responsibility.</p>
<section id="account-management">
<h3><span class="sectnum">2.2.1 </span>Account Management<a class="headerlink" href="#account-management" title="Link to this heading"></a></h3>
<h3><span class="section-number">2.2.1. </span><span class="sectnum">2.2.1 </span>Account Management<a class="headerlink" href="#account-management" title="Link to this heading"></a></h3>
<p>Accounts can be created using the accounts menu. Accounts contain very little information. You will see
report settings, which don’t have to be altered. Just fill out the name and the Internet.nl API credentials.</p>
<img alt="_images/account_list.png" src="_images/account_list.png" />
Expand All @@ -74,7 +76,7 @@ <h3><span class="sectnum">2.2.1 </span>Account Management<a class="headerlink" h
<img alt="_images/account_edit.png" src="_images/account_edit.png" />
</section>
<section id="user-management">
<h3><span class="sectnum">2.2.2 </span>User Management<a class="headerlink" href="#user-management" title="Link to this heading"></a></h3>
<h3><span class="section-number">2.2.2. </span><span class="sectnum">2.2.2 </span>User Management<a class="headerlink" href="#user-management" title="Link to this heading"></a></h3>
<p>User management is a bit more challenging. An account can have multiple users. That’s what you see in the screenshot
below: both users are in the ‘Internet.nl’ account.</p>
<img alt="_images/user_list.png" src="_images/user_list.png" />
Expand Down Expand Up @@ -108,15 +110,22 @@ <h1 class="logo"><a href="index.html">Internet.nl Dashboard</a></h1>

<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Administration Manual</span></p>
<ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="1_installation.html">1. <span class="sectnum">1 </span>Installation guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="3_email_templates.html">2. <span class="sectnum">3 </span>Email Templates</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">2. <span class="sectnum">2 </span>Dashboard User Management</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#overview">2.1. <span class="sectnum">2.1 </span>Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="#management">2.2. <span class="sectnum">2.2 </span>Management</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="3_email_templates.html">3. <span class="sectnum">3 </span>Email Templates</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="1_installation.html" title="previous chapter"><span class="section-number">1. </span><span class="sectnum">1 </span>Installation guide</a></li>
<li>Next: <a href="3_email_templates.html" title="next chapter"><span class="section-number">3. </span><span class="sectnum">3 </span>Email Templates</a></li>
</ul></li>
</ul>
</div>
Expand Down Expand Up @@ -150,7 +159,7 @@ <h3 id="searchlabel">Quick search</h3>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

|
<a href="_sources/2_user_anagement.rst.txt"
<a href="_sources/2_user_management.rst.txt"
rel="nofollow">Page source</a>
</div>

Expand Down
Loading

0 comments on commit 3c43ab4

Please sign in to comment.