misc updates for doc structure

Max Ma · Max Ma · commit 3ac1d8919651 · 2024-04-22T13:34:24.000Z
diff --git a/features.rst b/features.rst
@@ -2,34 +2,32 @@
 Features
 =========
 
-User Management
-===============
-
 .. toctree::
    :maxdepth: 1
 
    user-management
+   egress-gateway
+   external-clients
+   acls
+   pro/index
+
+**User Management**
 
+:ref:`user-manage`
 
-Egress Gateway
-===============
+**Egress Gateway**
 
 Allows clients (nodes and ext clients) to reach external networks.
 
 :ref:`egress`
 
-
-Remote Access Gateways & Clients
-=================================
+**Remote Access Gateways & Clients**
 
 A remote access gateway enables "external" clients to connect to the network. External clients refer to clients that are not part of the mesh network, but need to connect to it. This could be a laptop, mobile device, or even a server that is not part of the network.
 
 :ref:`remote-access`
 
-
-
-Access Control Lists
-======================
+**Access Control Lists**
 
 ACLs control communications between nodes on a network
 
diff --git a/how-to-guides.rst b/how-to-guides.rst
@@ -2,54 +2,40 @@
 How-to-Guides
 ==============
 
+.. toctree::
+   :maxdepth: 1
+
+   integrating-non-native-devices
+   usage
 
-Egress Gateway
-===============
+**Egress Gateway**
 
 
 Netmaker allows your clients to reach external networks via an Egress Gateway. The Egress Gateway is a netclient which has been deployed to a server or router with access to a given subnet.
 
 In the Netmaker UI, that node is set as an "egress gateway." Range(s) are specified which this node has access to. Once created, all clients (and all new ext clients) in the network will be able to reach those ranges via the gateway.
 
-.. toctree::
-   :maxdepth: 2
-
-   egress-gateway
+:ref:`egress`
 
-Remote Access Gateway/External Clients
-======================================
+**Remote Access Gateway/External Clients**
 
 Netmaker allows for "external clients" to reach into a network and access services via an Remote Access Gateway. So what is an "external client"? An external client is any machine which cannot or should not be meshed. This can include:
         - Phones
         - Laptops
         - Desktops
 
-.. toctree::
-   :maxdepth: 2
+:ref:`remote-access`
 
-   external-clients
+**Access Control Lists**
 
-Access Control Lists
-======================
 By default, Netmaker creates a "full mesh," meaning every node in your network can talk to every other node. You don't always want this to be the case. Sometimes, only some connections should be valid. That's why Netmaker has ACLs. By using Netmaker's ACL feature, you can enable/disable any peer-to-peer connection in your network to remove its ability to communicate.
 
-.. toctree::
-   :maxdepth: 2
+:ref:`acls`
 
-   acls
+**Integrating Non-native Devices**
 
-Integrating Non-native Devices
-===============================
+:ref:`integrating-non-native-devices`
 
-.. toctree::
-   :maxdepth: 1
-
-   integrating-non-native-devices
+**External Guides**
 
-External Guides
-================
-
-.. toctree::
-   :maxdepth: 2
-
-   usage
+:ref:`usage`
diff --git a/netclient.rst b/netclient.rst
@@ -1,3 +1,5 @@
+.. _netclient:
+
 ==========
 Netclient 
 ==========
diff --git a/pro/index.rst b/pro/index.rst
@@ -3,15 +3,28 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+=====================
+Netmaker Professional
+=====================
+
+.. toctree::
+   :maxdepth: 1
+
+   pro-setup
+   pro-users
+   pro-relay-server
+   pro-metrics
+   pro-branding
+   rac
+   pro-failovers
+   internet-gateways
+
 
 .. image:: ../images/netmaker.png
    :width: 100%
    :alt: Netmaker WireGuard
    :align: center
 
-Netmaker Professional
-======================
-
 Netmaker Professional is our advanced Netmaker offering for business use cases. It offers all the features of community edition plus:
 
 - **Metrics:** Nodes collect networking metrics such as latency, transfer, and connectivity status. These are displayed in the Netmaker UI, and also exported to Grafana via Prometheus.
@@ -26,72 +39,3 @@ Netmaker Professional is our advanced Netmaker offering for business use cases.
 
 - **Internet Gateways:** These work similar to traditional VPNs, and can work with netclients (hosts in the mesh network) as well as with remote devices connected to the network via client configs.
 
-
-Setup
---------
-
-How to set up Netmaker Professional
-
-.. toctree::
-   :maxdepth: 2
-
-   pro-setup
-
-Users
----------------
-
-.. toctree::
-   :maxdepth: 2
-   
-   pro-users
-
-Relays
----------------
-
-.. toctree::
-   :maxdepth: 2
-   
-   pro-relay-server
-
-Metrics
-------------------------------------
-
-How to view network metrics in Netmaker Professional
-
-
-.. toctree::
-   :maxdepth: 2
-
-   pro-metrics
-
-Branding
-------------
-
-.. toctree::
-   :maxdepth: 2
-
-   pro-branding
-
-Remote Access Client
------------------------
-
-.. toctree::
-   :maxdepth: 2
-
-   rac
-
-FailOvers
------------------------
-
-.. toctree::
-   :maxdepth: 2
-
-   pro-failovers
-
-Internet Gateways
------------------------
-
-.. toctree::
-   :maxdepth: 2
-
-   internet-gateways
diff --git a/pro/internet-gateways.rst b/pro/internet-gateways.rst
@@ -22,8 +22,7 @@ This behaviour also happens with remote access gateways and their connected clie
 Usage
 ======
 
-Create an internet gateway
---------------------------
+**Create an internet gateway**
 
 .. image:: images/inet-gw-create.png
    :alt: internet gateway creation
@@ -41,8 +40,7 @@ Create an internet gateway
 **NOTE:** A host already connected to an internet gateway cannot be a gateway itself. ie: internet gateway chaining is not supported currently.
 
 
-Update an internet gateway
---------------------------
+**Update an internet gateway**
 
 .. image:: images/inet-gw-update.png
    :alt: internet gateway update
@@ -54,8 +52,7 @@ Update an internet gateway
 3. Update the gateway and save changes
 
 
-Delete an internet gateway
---------------------------
+**Delete an internet gateway**
 
 .. image:: images/inet-gw-delete.png
    :alt: internet gateway deletion
diff --git a/pro/pro-setup.rst b/pro/pro-setup.rst
@@ -1,6 +1,6 @@
-=================================
-Netmaker Professional
-=================================
+===========================
+Netmaker Professional Setup
+===========================
 
 This guide covers how to get setup with Netmaker Professional. For pricing,visit `our pricing page <https://www.netmaker.io/pricing>`_
 
@@ -100,4 +100,4 @@ In Netmaker.env, change the following:
 .. code-block::
 
     METRICS_EXPORTER=on
-    PROMETHEUS=on
+    PROMETHEUS=on
diff --git a/pro/pro-users.rst b/pro/pro-users.rst
@@ -3,6 +3,7 @@
 
 Users in Netmaker Professional
 ---------------------------------
+
 Netmaker Professional offers advanced user management features. The super admin can create users with either a user or admin role. Only Admins can access the dashboard, the normal users can use remote access client to join the network through a gateway.
 Admins can add users and assign them to remote access gateways, which includes managing the user's access to different remote access gateways.
 
@@ -14,8 +15,10 @@ Here is a breakdown of the different user types and their permissions:
 
 * Super Admin: Super admins have full access to Netmaker. They can create and manage users, admins, networks, and gateways. They can also manage user and admin permissions.
 
+
 Adding users
----------------
+============
+
 To add a user, go to the Users section and click the Add User button. Fill in the user's details, including their name, password, and role.
 
 * As a super admin, you can add users with the role of admin or user.
@@ -29,7 +32,8 @@ To add a user, go to the Users section and click the Add User button. Fill in th
 The credentials will need to be shared with the added user.
 
 Attaching or removing user from a remote access gateway
-------------------------------------------------------------
+=======================================================
+
 To attach users to a remote access gateway or remove users from a gateway, you will need to have the gateway set up. 
 Once the remote access gateway is set up, you will see an option to attach or remove users from the gateway's dropdown menu on the table row.
 
@@ -47,7 +51,7 @@ You can click the button to either attach or remove a user
 
 
 Transferring super admin rights
-----------------------------------
+===============================
 
 Super admin rights can be transferred only to another admin. To do this, on the users page, go to the superadmin row and hover over the ellipsis.
 You will see an option to transfer admin rights. On clicking it, a dialog box will open allowing you to select any admin 
diff --git a/references.rst b/references.rst
@@ -26,10 +26,7 @@ Netclient
 ===========
 Netclient manages WireGuard on client devices (nodes)
 
-.. toctree::
-   :maxdepth: 2
-
-   netclient
+:ref:`netclient`
 
 NMCTL
 ======
diff --git a/usage.rst b/usage.rst
@@ -1,3 +1,5 @@
+.. _usage:
+
 =================
 External Guides
 =================
@@ -18,4 +20,4 @@ Written Tutorials
 
 * `K3s Cross-cloud cluster <https://itnext.io/how-to-deploy-a-single-kubernetes-cluster-across-multiple-clouds-using-k3s-and-wireguard-a5ae176a6e81>`_: Tutorial on setting up cross-cloud K3s clusters using Netmaker.
 * `MicroK8s Cross-cloud cluster <https://itnext.io/how-to-deploy-a-cross-cloud-kubernetes-cluster-with-built-in-disaster-recovery-bbce27fcc9d7>`_: Tutorial on setting up cross-cloud MicroK8s clusters using Netmaker.
-* `Secure access to private services <https://afeiszli.medium.com/how-to-enable-secure-access-to-your-hosted-services-using-netmaker-and-wireguard-1b3282d4b7aa>`_: Tutorial on setting up secure Nextcloud with Netmaker.
+* `Secure access to private services <https://afeiszli.medium.com/how-to-enable-secure-access-to-your-hosted-services-using-netmaker-and-wireguard-1b3282d4b7aa>`_: Tutorial on setting up secure Nextcloud with Netmaker.
diff --git a/user-management.rst b/user-management.rst
@@ -1,9 +1,11 @@
+.. _user-manage:
+
 ======================
 User Management
 ======================
 
-Superadmin Signup
-==================
+**Superadmin Signup**
+
 
 
 
@@ -31,4 +33,4 @@ Input your username and a super memorable but strong password then click on the
 
 
 .. include:: pro/rac.rst
-   :start-after: .. include_after_this_label
+   :start-after: .. include_after_this_label

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _netclient:`
	`2`	`+`
`1`	`3`	`==========`
`2`	`4`	`Netclient`
`3`	`5`	`==========`