Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some small documentation tweaks #119

Merged
merged 6 commits into from Mar 9, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 6 additions & 4 deletions mkdocs.yml
Expand Up @@ -7,7 +7,9 @@ python:
- requirements: docs/requirements.txt
theme:
name: readthedocs
navigation_depth: 3
navigation_depth: 4
hljs_languages:
- yaml
extra_css:
- extra.css
markdown_extensions:
Expand All @@ -19,9 +21,9 @@ markdown_extensions:
nav:
- Introduction: 'index.md'
- Installation:
- Install Nautobot: 'installation/index.md'
- Deploy Nautobot: 'installation/nautobot.md'
- Configure Web Services: 'installation/wsgi.md'
- Install Prerequisites: 'installation/index.md'
- Install Nautobot: 'installation/nautobot.md'
- Deploy Nautobot: 'installation/wsgi.md'
- Configure HTTP Server: 'installation/http-server.md'
- Configure External Authentication (Optional): 'installation/external-authentication.md'
- Administration:
Expand Down
2 changes: 1 addition & 1 deletion nautobot/docs/administration/nautobot-shell.md
Expand Up @@ -175,7 +175,7 @@ To modify an existing object, we retrieve it, update the desired field(s), and c
```

!!! warning
It is recommended to make use of the `validated_save()` convenience method which exists on all core models. While the Django `save()` method still exists, the `validated_save()` method saves the instance data but first enforces model validation logic. Simply calling `save()` on the model instance **does not** enforce validation automatically and may lead to bad data. See the development [best practices](../development/best-practices.md).
It is recommended to make use of the `validated_save()` convenience method which exists on all core models. While the Django `save()` method still exists, the `validated_save()` method saves the instance data but first enforces model validation logic. Simply calling `save()` on the model instance **does not** enforce validation automatically and may lead to bad data. See the development [best practices](../development/best-practices.md).

!!! warning
The Django ORM provides methods to create/edit many objects at once, namely `bulk_create()` and `update()`. These are best avoided in most cases as they bypass a model's built-in validation and can easily lead to database corruption if not used carefully.
Expand Down
Binary file added nautobot/docs/img/favicon.ico
Binary file not shown.
5 changes: 4 additions & 1 deletion nautobot/docs/installation/nautobot.md
Expand Up @@ -262,6 +262,9 @@ Next, connect to the name or IP of the server (as defined in `ALLOWED_HOSTS`) on
!!! warning
If the test service does not run, or you cannot reach the Nautobot home page, something has gone wrong. Do not proceed with the rest of this guide until the installation has been corrected.

!!! important
Certain Nautobot features (Git repository synchronization, webhooks, jobs, etc.) depend on the presence of Nautobot's background worker process, which is not automatically started by the `runserver` command. To start it for testing purposes, you can run `nautobot-server rqworker` separately. For production use, both Nautobot and the worker should be managed by systemd rather than started manually, as described in the next section of this documentation.

Note that the initial user interface will be locked down for non-authenticated users.

![Nautobot UI as seen by a non-authenticated user](../media/installation/nautobot_ui_guest.png)
Expand All @@ -270,4 +273,4 @@ Try logging in using the superuser account we just created. Once authenticated,

![Nautobot UI as seen by an administrator](../media/installation/nautobot_ui_admin.png)

Type `Ctrl-C` to stop the development server.
Type `Ctrl-C` to stop the development server. Now you're ready to proceed to [starting Nautobot as a system service](../wsgi).