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

Add documentation #4

Merged
merged 38 commits into from
May 12, 2020
Merged

Add documentation #4

merged 38 commits into from
May 12, 2020

Conversation

hoanhan101
Copy link
Contributor

No description provided.

README.md Outdated

```
pip install netbox-virtual-circuit-plugin

Choose a reason for hiding this comment

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

is this project hosted on pypi?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes that’s the plan

README.md Outdated
Comment on lines 15 to 17
Virtual Circuit, it can not exist in another Virtual Circuit without first being
removed.

Choose a reason for hiding this comment

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

I'm not sure I understand what this sentence is saying

Copy link

@edaniszewski edaniszewski left a comment

Choose a reason for hiding this comment

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

lgtm!

my only question here is whether we will want this published on pypi since it seems like something we'd only use internally, but I may not be thinking of all use cases, etc. so that can be a discussion for later

@hoanhan101
Copy link
Contributor Author

Good point. I will open a separate issue to keep track of this. As for now, my only thought for publishing it to pypi is that it would save us a ton of time to install and enable the plugin in Netbox, though I might not know if there's also another good way to do so.

@hoanhan101 hoanhan101 merged commit cbfc37a into master May 12, 2020
@hoanhan101 hoanhan101 deleted the readme branch May 12, 2020 14:30
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.

2 participants