Fixes: #160 - Rewrite the README with installation, usage, data model and API documentation - #170
Open
jsenecal wants to merge 2 commits into
Open
Fixes: #160 - Rewrite the README with installation, usage, data model and API documentation#170jsenecal wants to merge 2 commits into
jsenecal wants to merge 2 commits into
Conversation
jsenecal
force-pushed
the
docs/160-readme-install
branch
from
August 20, 2026 20:33
5c294b1 to
553901b
Compare
jsenecal
changed the title
… README The installation section only showed the PLUGINS configuration change, which is not enough to get the plugin running. Document the complete procedure: pip install, local_requirements.txt, PLUGINS, migrations and a restart, with a pointer for netbox-docker users. The restart method is left to the reader since it varies by deployment. Also refresh the rest of the README while in there: - Update the requirements to match the current code (NetBox 4.5+, Python 3.12+) - Reorient the compatibility matrix by NetBox version, as proposed by cruse1977 in DanSheps#150, and extend it with NetBox 4.6.x - Document the license_card_position setting and the Licenses card - Add the Module page to the Support Contracts card description - Drop the empty Usage and Additional Notes sections
Document how the pieces fit together for new users: - A quickstart walking through hardware lifecycle records, the vendor/SKU/contract/assignment chain and license assignments - A data model overview, including the distinction between NetBox manufacturers and the plugin's Vendor model - The REST API endpoints and a note on the GraphQL schema - An upgrading section and a pointer to the GitHub releases page - PyPI and CI badges
jsenecal
force-pushed
the
docs/160-readme-install
branch
from
August 20, 2026 20:44
df4ab70 to
a376906
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The README's installation section only showed the
PLUGINSconfiguration change, which leaves NetBox unable to start since the package itself is never installed (#160). This rewrites the README: the complete installation procedure, plus the sections a new user needs to get productive.Changes
local_requirements.txt,PLUGINS,migrate, restart), with a pointer to the netbox-docker plugin instructions for Docker users. The restart method is left to the reader since it varies by deployment.migrate, and a pointer to the GitHub releases pagemin_version = 4.5.0,requires-python >= 3.12)/api/plugins/lifecycle/and a note on the GraphQL schemalicense_card_positionsetting and the Licenses card, and added the Module page to the Support Contracts card descriptionIncorporates #150.
Fixes: #160