Merge pull request #110 from nautobot/develop

Release 1.0.0

.cookiecutter.json

@@ -4,9 +4,9 @@
         "full_name": "Network to Code, LLC",
         "email": "[email protected]",
         "github_org": "nautobot",
-        "plugin_name": "nautobot_design_builder",
+        "app_name": "nautobot_design_builder",
         "verbose_name": "Nautobot Design Builder",
-        "plugin_slug": "nautobot-design-builder",
+        "app_slug": "nautobot-design-builder",
         "project_slug": "nautobot-app-design-builder",
         "repo_url": "https://github.com/nautobot/nautobot-app-design-builder",
         "base_url": "design-builder",
@@ -17,7 +17,7 @@
         "model_class_name": "None",
         "open_source_license": "Apache-2.0",
         "docs_base_url": "https://docs.nautobot.com",
-        "docs_app_url": "https://docs.nautobot.com/projects/nautobot-design-builder/en/latest",
+        "docs_app_url": "https://docs.nautobot.com/projects/design-builder/en/latest",
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",

README.md

@@ -1,10 +1,10 @@
 # Nautobot Design Builder
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-design-builder/develop/docs/images/icon-design-builder.png" class="logo" height="200px">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-design-builder/develop/docs/images/icon-nautobot-design-builder.png" class="logo" height="200px">
   <br>
   <a href="https://github.com/nautobot/nautobot-app-design-builder/actions"><img src="https://github.com/nautobot/nautobot-app-design-builder/actions/workflows/ci.yml/badge.svg?branch=main"></a>
-  <a href="https://docs.nautobot.com/projects/nautobot-design-builder/en/latest"><img src="https://readthedocs.org/projects/nautobot-app-design-builder/badge/"></a>
+  <a href="https://docs.nautobot.com/projects/design-builder/en/latest/"><img src="https://readthedocs.org/projects/nautobot-app-design-builder/badge/"></a>
   <a href="https://pypi.org/project/nautobot-design-builder/"><img src="https://img.shields.io/pypi/v/nautobot-design-builder"></a>
   <a href="https://pypi.org/project/nautobot-design-builder/"><img src="https://img.shields.io/pypi/dm/nautobot-design-builder"></a>
   <br>
@@ -19,20 +19,20 @@ Design Builder is a Nautobot application for easily populating data within Nauto
 
 Full documentation for this App can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:
 
-- [User Guide](https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
-- [Administrator Guide](https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
-- [Developer Guide](https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
-- [Release Notes / Changelog](https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/admin/release_notes/).
-- [Frequently Asked Questions](https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/user/faq/).
+- [User Guide](https://docs.nautobot.com/projects/design-builder/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
+- [Administrator Guide](https://docs.nautobot.com/projects/design-builder/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
+- [Developer Guide](https://docs.nautobot.com/projects/design-builder/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
+- [Release Notes / Changelog](https://docs.nautobot.com/projects/design-builder/en/latest/admin/release_notes/).
+- [Frequently Asked Questions](https://docs.nautobot.com/projects/design-builder/en/latest/user/faq/).
 
 ### Contributing to the Documentation
 
 You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-app-design-builder/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
 
-If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
+If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/design-builder/en/latest/dev/dev_environment/#full-docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
 
 Any PRs with fixes or improvements are very welcome!
 
 ## Questions
 
-For any questions or comments, please check the [FAQ](https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.
+For any questions or comments, please check the [FAQ](https://docs.nautobot.com/projects/design-builder/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.

development/docker-compose.dev.yml

@@ -12,8 +12,6 @@ services:
     volumes:
       - "./nautobot_config.py:/opt/nautobot/nautobot_config.py"
       - "../:/source"
-      - "../examples/backbone_design/designs:/opt/nautobot/designs:cached"
-      - "../examples/backbone_design/jobs:/opt/nautobot/jobs:cached"
     healthcheck:
       test: ["CMD", "true"]  # Due to layering, disable: true won't work. Instead, change the test
   docs:
@@ -34,8 +32,6 @@ services:
     volumes:
       - "./nautobot_config.py:/opt/nautobot/nautobot_config.py"
       - "../:/source"
-      - "../examples/backbone_design/designs:/opt/nautobot/designs:cached"
-      - "../examples/backbone_design/jobs:/opt/nautobot/jobs:cached"
     healthcheck:
       test: ["CMD", "true"]  # Due to layering, disable: true won't work. Instead, change the test
 # To expose postgres or redis to the host uncomment the following

docs/admin/release_notes/version_1.0.md

@@ -1,11 +1,5 @@
 # v1.0 Release Notes
 
-This document describes all new features and changes in the release `1.0`. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## Release Overview
-
-Initial Public Release
-
 ## [v1.0.0] - 2023-11-01
 
 Initial Public Release

docs/user/app_getting_started.md

@@ -8,27 +8,21 @@ To install the App, please follow the instructions detailed in the [Installation
 
 ## First steps with the App
 
-The easiest way to experience Design Builder is to run it in a local environment. To start a local environment, clone the design builder git repository and start the application stack. The only requirements for starting a local environment are `docker`, `docker-compose` and [invoke](https://www.pyinvoke.org/installing.html). Once the dependent tools have been installed you'll need to build the docker image by running `invoke build`. At that point, simply run the command `invoke start`. This will start the entire application stack using docker compose. Once the application stack is up and running, navigate to <http://127.0.0.1:8080/> and login.
+The easiest way to experience Design Builder is to either add the [demo-designs](https://github.com/nautobot/demo-designs) as a git data source in an existing Nautobot environment, or to clone that repository and run it in a local environment. To start a local environment, clone the [demo-designs](https://github.com/nautobot/demo-designs) git repository and start the application stack. The only requirements for starting a local environment are `docker`, `docker-compose` and [invoke](https://www.pyinvoke.org/installing.html). Once the dependent tools have been installed you'll need to build the docker image by running `invoke build`. At that point, simply run the command `invoke start`. This will start the entire application stack using docker compose. Once the application stack is up and running, navigate to <http://127.0.0.1:8080/> and login. By default, the application stack will use Nautobot version 1.6. To see design builder in Nautobot 2, copy the `invoke.nautobot_2.yml` to `invoke.yml` and restart the application stack.
 
 ## What are the next steps?
 
-The Design Builder application ships with some sample designs to demonstrate capabilities. Once the application stack is ready, you should have two designs listed under the "Jobs" -> "Jobs" menu item.
+The Design Builder demo designs ship with some sample designs to demonstrate capabilities. Once the application stack is ready, you should have several jobs listed under the "Jobs" -> "Jobs" menu item.
 
 ![Jobs list](../images/screenshots/sample-design-jobs-list.png)
 
-Note that both jobs are disabled. Nautobot automatically marks jobs as disabled when they are first loaded. In order to run these jobs, click the edit button ![edit button](../images/screenshots/edit-button.png) and check the "enabled" checkbox:
+Note that the jobs are disabled. Nautobot automatically marks jobs as disabled when they are first loaded. In order to run these jobs, click the edit button ![edit button](../images/screenshots/edit-button.png) and check the "enabled" checkbox:
 
 ![enabled checkbox](../images/screenshots/job-enabled-checkbox.png)
 
 Once you click `save`, the jobs should be runnable.
 
-To implement any design, click the run button [run button](../images/screenshots/run-button.png). For example, run the "Initial Data" job, which will add a manufacturer, a device type, a device role, several regions and several sites. Additionally, each site will have two devices. Here is the design template for this design:
-
-```jinja
---8<-- "examples/backbone_design/designs/core_site/designs/0001_design.yaml.j2"
-```
-
-If you run the job you should see output in the job result that shows the various objects being created:
+To implement any design, click the run button [run button](../images/screenshots/run-button.png). For example, run the "Initial Data" job, which will add a manufacturer, a device type, a device role, several regions and several sites. Additionally, each site will have two devices. If you run the job you should see output in the job result that shows the various objects being created:
 
 ![design job result](../images/screenshots/design-job-result.png)