From ca7328c25c889a028c155140c393a13dc9908bbf Mon Sep 17 00:00:00 2001 From: Jan Snasel Date: Thu, 22 Feb 2024 11:12:23 +0000 Subject: [PATCH 1/2] fix: Docs --- README.md | 5 ++++- changes/6.housekeeping | 1 + docs/dev/extending.md | 5 +---- 3 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 changes/6.housekeeping diff --git a/README.md b/README.md index 6cddff2..b340278 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Nautobot Dev Example App +This application serves as a testbed for evaluating improvements to the [Nautobot app cookiecutter templates](https://github.com/nautobot/cookiecutter-nautobot-app). It is not intended to be used directly in production environments. + +For those initiating a new Nautobot app, utilize the [cookiecutter template](https://github.com/nautobot/cookiecutter-nautobot-app) as a starting point. +


@@ -16,7 +20,6 @@ An example Nautobot app with multiple functions: - Acts as a Canary App to test enhancements to the Nautobot app [cookiecutter templates](https://github.com/nautobot/cookiecutter-nautobot-app). -- Offers a starting point for developing new apps. - Illustrates how to use the Nautobot app framework. ### Screenshots diff --git a/changes/6.housekeeping b/changes/6.housekeeping new file mode 100644 index 0000000..09a4b12 --- /dev/null +++ b/changes/6.housekeeping @@ -0,0 +1 @@ +Fixed the documentation to explain the app usage. diff --git a/docs/dev/extending.md b/docs/dev/extending.md index 49b89f4..9394303 100644 --- a/docs/dev/extending.md +++ b/docs/dev/extending.md @@ -1,6 +1,3 @@ # Extending the App -!!! warning "Developer Note - Remove Me!" - Information on how to extend the App functionality. - -Extending the application is welcome, however it is best to open an issue first, to ensure that a PR would be accepted and makes sense in terms of features and design. +This app is designed to be an internal tool for testing and development purposes. From e7f6581dea3b2460af53b801a20c6ac7f24acdac Mon Sep 17 00:00:00 2001 From: Cristian Date: Thu, 22 Feb 2024 12:06:20 +0000 Subject: [PATCH 2/2] Apply suggestions from code review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b340278..895ed51 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Nautobot Dev Example App -This application serves as a testbed for evaluating improvements to the [Nautobot app cookiecutter templates](https://github.com/nautobot/cookiecutter-nautobot-app). It is not intended to be used directly in production environments. +This application serves as a testbed for evaluating improvements to the [Nautobot App Cookiecutter Templates](https://github.com/nautobot/cookiecutter-nautobot-app). **DO NOT USE** this repository directly in production environments or to bootstrap a new app! -For those initiating a new Nautobot app, utilize the [cookiecutter template](https://github.com/nautobot/cookiecutter-nautobot-app) as a starting point. +For those wanting to develop a new Nautobot app, please use the [cookiecutter template](https://github.com/nautobot/cookiecutter-nautobot-app) as a starting point.