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

Added an example diagram to the document quick-start #56

Open
congto opened this issue Dec 25, 2024 · 3 comments
Open

Added an example diagram to the document quick-start #56

congto opened this issue Dec 25, 2024 · 3 comments
Labels
status: accepted This issue is accepted and being worked on type: documentation Improvements or additions to documentation

Comments

@congto
Copy link

congto commented Dec 25, 2024

Proposed Changes

I'm interested in your plugin and trying to install it.

I looked at the quick start documentation, I thought, if you can add a model with an explanation, it will be easier to visualize.

This supplement may be located in section

https://github.com/Alef-Burzmali/netbox-data-flows/blob/main/docs/quick-start.md#basic-example

Thanks

@congto congto added status: pending triage New issue or feature request waiting for triage type: documentation Improvements or additions to documentation labels Dec 25, 2024
@Alef-Burzmali
Copy link
Owner

Thanks for the suggestion. I don't understand what the model should represent, though. Are you talking about an example flow diagram for the "ACME" application of the tutorial? Or a model of the relationship between the different objects like on that page?

@congto
Copy link
Author

congto commented Dec 30, 2024

Thanks for the suggestion. I don't understand what the model should represent, though. Are you talking about an example flow diagram for the "ACME" application of the tutorial? Or a model of the relationship between the different objects like on that page?

This is example

image

You insert here

image

@Alef-Burzmali Alef-Burzmali added status: accepted This issue is accepted and being worked on and removed status: pending triage New issue or feature request waiting for triage labels Dec 30, 2024
@Alef-Burzmali
Copy link
Owner

Ok, that's clear. I will add that, thanks for the suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepted This issue is accepted and being worked on type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants