readme new user updates #95
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi!
First off, great job on the documentation and project! Really well done in terms of technology choices and usability. It was super simple to get up and going with Docker / Poetry / Invoke.
When I was following the README installing with Docker Compose Nautobot, I noticed a few minor improvements that could be made. Feel free to use other verbiage or other ways of solving the same issue.
Basically 2 things about the install process could be improved:
Main README
## Install Poetry, I assumed the next step was## Build and start Nautobotand was confused why things were not working, especially with the phraseNautobot will be available on port 8080 locally http://localhost:8080, I assumed I had done something wrong.I then realized after scrolling through several more subsections, after doing some troubleshooting that there was a full
## Getting Startedsection that I didn't see and included important steps like copying the.envfiles and such. Once I followed those steps everything worked well.In order to call attention to the Getting Started part, I added some explanation early on
## How to use this repopart, though including a table of contents to show people that the Getting Started part is way far down the README is another option.## Super User Account, but did not realize it was a required step if I wanted to authenticate into the app.For the sake of clarity, I added a phrase at the beginning of that section to let people know this is required if you are testing locally, the credential files are not enough.