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

[resoto][docs] Add an example of the rendering script usage #773

Merged
merged 1 commit into from Apr 20, 2022

Conversation

meln1k
Copy link
Member

@meln1k meln1k commented Apr 7, 2022

Description

Added the graph rendering script instructions in the readme

To-Dos

  • Add test coverage for new or updated functionality
  • Lint and test with tox
  • Document new or updated functionality (someengineering/resoto.com#XXXX)

Code of Conduct

By submitting this pull request, I agree to follow the code of conduct.

@meln1k meln1k requested a review from TheCatLady as a code owner April 7, 2022 08:30
Copy link
Member

@aquamatthias aquamatthias left a comment

Choose a reason for hiding this comment

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

The project README is very high level. I feel the diagram tool is too specific here - so people get confused.

Proposals:

  • this kind of documentation should be part of the script itself
  • we probably should have a section on our docs site explaining the usage (e.g. a section called add ons or integrations or similar)
  • if we find a good example diagram, we cam put it in the README

lloesche
lloesche previously approved these changes Apr 8, 2022
@meln1k meln1k force-pushed the nm/dot-rendering-readme-entry branch from 0b34d21 to 2b9c9ee Compare April 13, 2022 10:00
@meln1k meln1k changed the title [resoto][docs] Add a readme note about the rendering script usage [resoto][docs] Add an example of the rendering script usage Apr 13, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #773 (2b9c9ee) into main (635a782) will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #773      +/-   ##
==========================================
+ Coverage   89.75%   89.78%   +0.03%     
==========================================
  Files          69       69              
  Lines        9737     9934     +197     
==========================================
+ Hits         8739     8919     +180     
- Misses        998     1015      +17     
Flag Coverage Δ
resotocore 89.78% <100.00%> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
resotocore/resotocore/__init__.py 100.00% <100.00%> (ø)
resotocore/resotocore/__main__.py 88.66% <100.00%> (+0.98%) ⬆️
resotocore/resotocore/cli/command.py 87.20% <100.00%> (+0.26%) ⬆️
resotocore/resotocore/core_config.py 94.81% <100.00%> (-1.98%) ⬇️
resotocore/resotocore/dependencies.py 87.60% <100.00%> (+1.65%) ⬆️
resotocore/resotocore/parse_util.py 100.00% <100.00%> (ø)
resotocore/resotocore/cli/cli.py 92.97% <0.00%> (-1.19%) ⬇️
resotocore/resotocore/web/certificate_handler.py 92.72% <0.00%> (-0.96%) ⬇️
resotocore/resotocore/model/model.py 92.56% <0.00%> (-0.95%) ⬇️
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 806b16b...2b9c9ee. Read the comment docs.

@meln1k meln1k removed the request for review from TheCatLady April 13, 2022 10:22
@aquamatthias aquamatthias merged commit 90c6905 into main Apr 20, 2022
@aquamatthias aquamatthias deleted the nm/dot-rendering-readme-entry branch April 20, 2022 06:36
lloesche pushed a commit that referenced this pull request Apr 21, 2022
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

4 participants