Structured docs layout

This commit is contained in:
Jeremy Stretch 2016-07-08 12:55:57 -04:00
parent b6e87d1526
commit 27c8cb046c
7 changed files with 15 additions and 13 deletions

View File

@ -1,5 +1,3 @@
<h1>Circuits</h1>
The circuits component of NetBox deals with the management of long-haul Internet and private transit links and providers.
[TOC]

View File

@ -1,5 +1,3 @@
<h1>DCIM</h1>
Data center infrastructure management (DCIM) entails all physical assets: sites, racks, devices, cabling, etc.
[TOC]

View File

@ -1,5 +1,3 @@
<h1>Extras</h1>
This section entails features of NetBox which are not crucial to its primary functions, but that provide additional value.
[TOC]

View File

@ -1,5 +1,3 @@
<h1>IPAM</h1>
IP address management (IPAM) entails the allocation of IP networks, addresses, and related numeric resources.
[TOC]

View File

@ -1,5 +1,3 @@
<h1>Secrets</h1>
"Secrets" are small amounts of data that must be kept confidential; for example, passwords and SNMP community strings. NetBox provides encrypted storage of secret data.
[TOC]

View File

@ -11,15 +11,15 @@ NetBox is an open source web application designed to help manage and document co
It was designed with the following tenets foremost in mind.
### Replicate the Real World
## Replicate the Real World
Careful consideration has been given to the data model to ensure that it can accurately reflect a real-world network. For instance, IP addresses are assigned not to devices, but to specific interfaces attached to a device, and an interface may have multiple IP addresses assigned to it.
### Serve as a "Source of Truth"
## Serve as a "Source of Truth"
NetBox intends to represent the _desired_ state of a network versus its _operational_ state. As such, automated import of live network state is strongly discouraged. All data created in NetBox should first be vetted by a human to ensure its integrity. NetBox can then be used to populate monitoring and provisioning systems with a high degree of confidence.
### Keep it Simple
## Keep it Simple
When given a choice between a relatively simple [80% solution](https://en.wikipedia.org/wiki/Pareto_principle) and a much more complex complete solution, the former will typically be favored. This ensures a lean codebase with a low learning curve.

12
mkdocs.yml Normal file
View File

@ -0,0 +1,12 @@
site_name: NetBox
pages:
- 'Introduction': 'index.md'
- 'Getting Started': 'getting-started.md'
- 'Configuration': 'configuration.md'
- 'Data Model':
- 'Circuits': 'data-model/circuits.md'
- 'DCIM': 'data-model/dcim.md'
- 'IPAM': 'data-model/ipam.md'
- 'Secrets': 'data-model/secrets.md'
- 'Extras': 'data-model/extras.md'
- 'API Integration': 'api-integration.md'