diff --git a/docs/circuits.md b/docs/data-model/circuits.md similarity index 98% rename from docs/circuits.md rename to docs/data-model/circuits.md index 357e5eae6..9246add30 100644 --- a/docs/circuits.md +++ b/docs/data-model/circuits.md @@ -1,5 +1,3 @@ -

Circuits

- The circuits component of NetBox deals with the management of long-haul Internet and private transit links and providers. [TOC] diff --git a/docs/dcim.md b/docs/data-model/dcim.md similarity index 99% rename from docs/dcim.md rename to docs/data-model/dcim.md index cc2cf5073..3595b09af 100644 --- a/docs/dcim.md +++ b/docs/data-model/dcim.md @@ -1,5 +1,3 @@ -

DCIM

- Data center infrastructure management (DCIM) entails all physical assets: sites, racks, devices, cabling, etc. [TOC] diff --git a/docs/extras.md b/docs/data-model/extras.md similarity index 99% rename from docs/extras.md rename to docs/data-model/extras.md index bd47d35d9..6ad9589af 100644 --- a/docs/extras.md +++ b/docs/data-model/extras.md @@ -1,5 +1,3 @@ -

Extras

- This section entails features of NetBox which are not crucial to its primary functions, but that provide additional value. [TOC] diff --git a/docs/ipam.md b/docs/data-model/ipam.md similarity index 99% rename from docs/ipam.md rename to docs/data-model/ipam.md index ff3810097..2313eeb99 100644 --- a/docs/ipam.md +++ b/docs/data-model/ipam.md @@ -1,5 +1,3 @@ -

IPAM

- IP address management (IPAM) entails the allocation of IP networks, addresses, and related numeric resources. [TOC] diff --git a/docs/secrets.md b/docs/data-model/secrets.md similarity index 99% rename from docs/secrets.md rename to docs/data-model/secrets.md index 9b7519fba..323b623b5 100644 --- a/docs/secrets.md +++ b/docs/data-model/secrets.md @@ -1,5 +1,3 @@ -

Secrets

- "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] diff --git a/docs/index.md b/docs/index.md index 86d47ea2c..1c99bab4b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..a3fb91b37 --- /dev/null +++ b/mkdocs.yml @@ -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'