-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This adds the fix for docs, backported from 2.3.1. This also fixes the CI so that it runs with Nautobot 1.6 instead of 2.3.x (Stable). Changed CI minimum version to hardcoded 1.6.0 as that is all that the LTM is meant to support, so we don't need to worry about trying to test anything older.
- Loading branch information
Showing
10 changed files
with
25 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 0 additions & 2 deletions
2
nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.postgres.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,4 @@ | ||
--- | ||
version: "3.8" | ||
|
||
services: | ||
nautobot: | ||
environment: | ||
|
1 change: 0 additions & 1 deletion
1
nautobot-app/{{ cookiecutter.project_slug }}/development/docker-compose.redis.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,4 @@ | ||
--- | ||
version: "3.8" | ||
services: | ||
redis: | ||
image: "redis:6-alpine" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,7 +31,7 @@ This project is managed by [Python Poetry](https://python-poetry.org/) and has a | |
|
||
1. Install Poetry, see the [Poetry documentation](https://python-poetry.org/docs/#installation) for your operating system. | ||
2. Install Docker, see the [Docker documentation](https://docs.docker.com/get-docker/) for your operating system. | ||
3. Install Docker-compose, see the [Docker-compose documentation](https://github.com/docker/compose) for your operation system. | ||
3. Install Docker Compose v2, see the [Docker Compose documentation](https://github.com/docker/compose) for your operation system. | ||
|
||
Once you have Poetry and Docker installed you can run the following commands (in the root of the repository) to install all other development dependencies in an isolated Python virtual environment: | ||
|
||
|
@@ -190,7 +190,7 @@ Next, you need to start up your Docker containers. | |
```bash | ||
➜ invoke start | ||
Starting Nautobot in detached mode... | ||
Running docker-compose command "up --detach" | ||
Running docker compose command "up --detach" | ||
Creating network "{{ cookiecutter.plugin_name }}_default" with the default driver | ||
Creating volume "{{ cookiecutter.plugin_name }}_postgres_data" with default driver | ||
Creating {{ cookiecutter.plugin_name }}_redis_1 ... | ||
|
@@ -241,8 +241,8 @@ If you need to create additional superusers, run the follow commands. | |
|
||
```bash | ||
➜ invoke createsuperuser | ||
Running docker-compose command "ps --services --filter status=running" | ||
Running docker-compose command "exec nautobot nautobot-server createsuperuser --username admin" | ||
Running docker compose command "ps --services --filter status=running" | ||
Running docker compose command "exec nautobot nautobot-server createsuperuser --username admin" | ||
Error: That username is already taken. | ||
Username: ntc | ||
Email address: [email protected] | ||
|
@@ -258,7 +258,7 @@ The last command to know for now is `invoke stop`. | |
```bash | ||
➜ invoke stop | ||
Stopping Nautobot... | ||
Running docker-compose command "down" | ||
Running docker compose command "down" | ||
Stopping {{ cookiecutter.plugin_name }}_worker_1 ... | ||
Stopping {{ cookiecutter.plugin_name }}_nautobot_1 ... | ||
Stopping {{ cookiecutter.plugin_name }}_docs_1 ... | ||
|
11 changes: 6 additions & 5 deletions
11
nautobot-app/{{ cookiecutter.project_slug }}/docs/requirements.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
mkdocs==1.5.2 | ||
mkdocs-material==9.1.15 | ||
mkdocs-version-annotations==1.0.0 | ||
mkdocstrings-python==1.5.2 | ||
mkdocstrings==0.22.0 | ||
mkdocs==1.6.0 | ||
mkdocs-material==9.5.32 | ||
markdown-version-annotations==1.0.1 | ||
griffe==1.1.1 | ||
mkdocstrings-python==1.10.8 | ||
mkdocstrings==0.25.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters