Started v2.4 documentation refresh

2025-12-24 06:07:47 -06:00 · 2018-07-17 17:23:10 -04:00
parent 8937362433
commit d77214fef6
34 changed files with 636 additions and 519 deletions
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,35 +1,48 @@
 site_name: NetBox
+repo_url: https://github.com/digitalocean/netbox

 pages:
-    - 'Introduction': 'index.md'
-    - 'Installation':
-        - 'PostgreSQL': 'installation/postgresql.md'
-        - 'NetBox': 'installation/netbox.md'
-        - 'Web Server': 'installation/web-server.md'
-        - 'LDAP (Optional)': 'installation/ldap.md'
-        - 'Upgrading': 'installation/upgrading.md'
-        - 'Migrating to Python3': 'installation/migrating-to-python3.md'
-    - 'Configuration':
-        - 'Mandatory Settings': 'configuration/mandatory-settings.md'
-        - 'Optional Settings': 'configuration/optional-settings.md'
-    - 'Data Model':
-        - 'Circuits': 'data-model/circuits.md'
-        - 'DCIM': 'data-model/dcim.md'
-        - 'IPAM': 'data-model/ipam.md'
-        - 'Secrets': 'data-model/secrets.md'
-        - 'Tenancy': 'data-model/tenancy.md'
-        - 'Virtualization': 'data-model/virtualization.md'
-        - 'Extras': 'data-model/extras.md'
-    - 'API':
-        - 'Overview': 'api/overview.md'
-        - 'Authentication': 'api/authentication.md'
-        - 'Working with Secrets': 'api/working-with-secrets.md'
-        - 'Examples': 'api/examples.md'
-    - 'Miscellaneous':
-        - 'Reports': 'miscellaneous/reports.md'
-        - 'Shell': 'miscellaneous/shell.md'
-    - 'Development':
-        - 'Utility Views': 'development/utility-views.md'
+    - Introduction: 'index.md'
+    - Installation:
+        - Installing NetBox: 'installation/index.md'
+        - 1. PostgreSQL: 'installation/1-postgresql.md'
+        - 2. NetBox: 'installation/2-netbox.md'
+        - 3. Web Server: 'installation/3-web-server.md'
+        - 4. LDAP (Optional): 'installation/4-ldap.md'
+        - Upgrading NetBox: 'installation/upgrading.md'
+        - Migrating to Python3: 'installation/migrating-to-python3.md'
+    - Configuration:
+        - Configuring NetBox: 'configuration/index.md'
+        - Required Settings: 'configuration/required-settings.md'
+        - Optional Settings: 'configuration/optional-settings.md'
+    - Core Functionality:
+        - IP Address Management: 'core-functionality/ipam.md'
+        - VLANs: 'core-functionality/vlans.md'
+        - Sites and Racks: 'core-functionality/sites-and-racks.md'
+        - Devices: 'core-functionality/devices.md'
+        - Virtual Machines: 'core-functionality/virtual-machines.md'
+        - Services: 'core-functionality/services.md'
+        - Circuits: 'core-functionality/circuits.md'
+        - Secrets: 'core-functionality/secrets.md'
+        - Tenancy: 'core-functionality/tenancy.md'
+    - Additional Features:
+        - Tags: 'additional-features/tags.md'
+        - Custom Fields: 'additional-features/custom-fields.md'
+        - Context Data: 'additional-features/context-data.md'
+        - Export Templates: 'additional-features/export-templates.md'
+        - Graphs: 'additional-features/graphs.md'
+        - Topology Maps: 'additional-features/topology-maps.md'
+        - Reports: 'additional-features/reports.md'
+        - Webhooks: 'additional-features/webhooks.md'
+        - Change Logging: 'additional-features/change-logging.md'
+        - NetBox Shell: 'additional-features/netbox-shell.md'
+    - API:
+        - Overview: 'api/overview.md'
+        - Authentication: 'api/authentication.md'
+        - Working with Secrets: 'api/working-with-secrets.md'
+        - Examples: 'api/examples.md'
+    - Development:
+        - Utility Views: 'development/utility-views.md'

 markdown_extensions:
    - admonition: