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

Revise deployment docs to use $PATH instead of venv activate #106

Merged
merged 2 commits into from
Mar 8, 2021

Conversation

jathanism
Copy link
Contributor

@jathanism jathanism commented Mar 6, 2021

Related to: #62

This revises and simplifies the install instructions again to totally eliminate "activating" or mentioning the virtualenv other than initially creating it and describing the application environment.

  • This now instructs the reader to rely on the $PATH (e.g. /opt/nautobot/bin)
  • All hard-coded, non-example references to /opt/nautobot have been changed to $NAUTOBOT_ROOT
  • The section describing "Activating the Virtual Environment" has been renamed to "Understanding the Virtualenv" and explains relying on the $PATH instead
  • All mention of activating the virtualenv of the prompt being prefixed with (nautobot) have been removed
  • Fixed all ../../ relative links to just use absolute paths (e.g. /configuration vs. ../../configuration)

This revises and simplifies the install instructions again to totally eliminate using the virtualenv at other than initially creating it.

- This now instructs the reader to rely on the `$PATH` (e.g. `/opt/nautobot/bin`)
- All hard-coded, non-example references to `/opt/nautobot` have been changed to `$NAUTOBOT_ROOT`
- The section describing "Activating the Virtual Environment" has been renamed to "Understanding the Virtualenv" and explains relying on the `$PATH` instead
- All mention of activating the virtualenv of the prompt being prefixed with `(nautobot)` have been removed
- Fixed all `../../` relative links to just use absolute paths (e.g. `/configuration` vs. `../../configuration`)
Copy link
Contributor

@glennmatthews glennmatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another step in the right direction!

nautobot/docs/configuration/required-settings.md Outdated Show resolved Hide resolved
nautobot/docs/installation/nautobot.md Outdated Show resolved Hide resolved
nautobot/docs/installation/nautobot.md Outdated Show resolved Hide resolved
nautobot/docs/installation/nautobot.md Show resolved Hide resolved
@jathanism jathanism merged commit d8d1884 into nautobot:develop Mar 8, 2021
@jathanism jathanism deleted the jathanism-install-path branch March 8, 2021 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants