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

docs: Updated branding from plugin to app #89

Merged
merged 1 commit into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<p align="center">
<img src="/docs/images/icon-design-builder.png" class="logo" height="200px">
<br>
<a href="https://github.com/networktocode-llc/nautobot-plugin-design-builder/actions"><img src="https://github.com/networktocode-llc/nautobot-plugin-design-builder/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://docs.nautobot.com/projects/design-builder/en/latest"><img src="https://readthedocs.org/projects/nautobot-plugin-design-builder/badge/"></a>
<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/design-builder/en/latest"><img src="https://readthedocs.org/projects/nautobot-app-design-builder/badge/"></a>
<a href="https://pypi.org/project/design-builder/"><img src="https://img.shields.io/pypi/v/design-builder"></a>
<a href="https://pypi.org/project/design-builder/"><img src="https://img.shields.io/pypi/dm/design-builder"></a>
<br>
Expand All @@ -27,7 +27,7 @@ Full documentation for this App can be found over on the [Nautobot Docs](https:/

### Contributing to the Documentation

You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/networktocode-llc/nautobot-plugin-design-builder/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
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/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.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ edit_uri: "edit/develop/docs"
site_dir: "nautobot_design_builder/static/nautobot_design_builder/docs"
site_name: "Design Builder Documentation"
site_url: "https://docs.nautobot.com/projects/nautobot-design-builder/en/latest/"
repo_url: "https://github.com/networktocode-llc/nautobot-plugin-design-builder"
repo_url: "https://github.com/nautobot/nautobot-app-design-builder"
copyright: "Copyright &copy; The Authors"
theme:
name: "material"
Expand Down
4 changes: 2 additions & 2 deletions nautobot_design_builder/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Plugin declaration for design_builder."""
"""App declaration for Nautobot Design Builder."""
from django.conf import settings
from django.utils.functional import classproperty

Expand All @@ -15,7 +15,7 @@


class DesignBuilderConfig(NautobotAppConfig):
"""Plugin configuration for the design_builder plugin."""
"""App configuration for the nautobot_design_builder app."""

name = "nautobot_design_builder"
verbose_name = "Design Builder"
Expand Down
8 changes: 4 additions & 4 deletions nautobot_design_builder/contrib/ext.py
Original file line number Diff line number Diff line change
Expand Up @@ -447,18 +447,18 @@ def attribute(self, value: dict, model_instance) -> None:


class BGPPeeringExtension(AttributeExtension):
"""Create BGP peerings in the BGP Models Plugin."""
"""Create BGP peerings in the BGP Models App."""

tag = "bgp_peering"

def __init__(self, builder: Builder):
"""Initialize the BGPPeeringExtension.

This initializer will import the necessary BGP models. If the
BGP models plugin is not installed then it raises a DesignImplementationError.
BGP models app is not installed then it raises a DesignImplementationError.

Raises:
DesignImplementationError: Raised when the BGP Models Plugin is not installed.
DesignImplementationError: Raised when the BGP Models App is not installed.
"""
super().__init__(builder)
try:
Expand All @@ -468,7 +468,7 @@ def __init__(self, builder: Builder):
self.Peering = Peering # pylint:disable=invalid-name
except ModuleNotFoundError:
raise DesignImplementationError(
"the `bgp_peering` tag can only be used when the bgp models plugin is installed."
"the `bgp_peering` tag can only be used when the bgp models app is installed."
)

@staticmethod
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Management command to bootstrap development data for design builder plugin."""
"""Management command to bootstrap development data for design builder app."""
import sys
import yaml

Expand Down
2 changes: 1 addition & 1 deletion nautobot_design_builder/tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Unit tests for design_builder plugin."""
"""Unit tests for design_builder app."""

import logging
import shutil
Expand Down
2 changes: 1 addition & 1 deletion nautobot_design_builder/util.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Main design builder plugin module, contains DesignJob and base plugin methods and functions."""
"""Main design builder app module, contains DesignJob and base methods and functions."""
import functools
import importlib
import inspect
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[tool.poetry]
name = "nautobot-design-builder"
version = "0.4.4"
description = "A plugin that uses design templates to easily create data objects in Nautobot with minimal input from a user."
description = "Nautobot app that uses design templates to easily create data objects in Nautobot with minimal input from a user."
authors = ["Network to Code, LLC <[email protected]>"]
readme = "README.md"
homepage = "https://github.com/networktocode-llc/nautobot-plugin-design-builder"
repository = "https://github.com/networktocode-llc/nautobot-plugin-design-builder"
homepage = "https://github.com/nautobot/nautobot-app-design-builder"
repository = "https://github.com/nautobot/nautobot-app-design-builder"
keywords = ["nautobot", "nautobot-plugin"]
include = [
"README.md",
Expand Down
Loading