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 basic scenario guides #36

Merged
merged 3 commits into from
Jun 23, 2021
Merged

Conversation

felixfontein
Copy link
Collaborator

SUMMARY

This adds two scenario guides using the extra docs feature. Once this is included in the next Ansible release, this will show up on https://docs.ansible.com/ansible/latest/collections/community/routeros/ !

Right now, you can look at the result of this PR at https://ansible.fontein.de/collections/community/routeros/index.html#plugins-in-community-routeros (note the two links under Guides):

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs

@codecov
Copy link

codecov bot commented Jun 14, 2021

Codecov Report

Merging #36 (a8b93ff) into main (1913a0d) will increase coverage by 0.06%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #36      +/-   ##
==========================================
+ Coverage   80.16%   80.23%   +0.06%     
==========================================
  Files          11       11              
  Lines        1190     1189       -1     
  Branches      161      161              
==========================================
  Hits          954      954              
+ Misses        174      173       -1     
  Partials       62       62              
Impacted Files Coverage Δ
plugins/modules/api.py 75.70% <0.00%> (+0.42%) ⬆️

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 1913a0d...a8b93ff. Read the comment docs.

@felixfontein
Copy link
Collaborator Author

@heuels @NikolayDachev would be glad if you could take a look at the result and tell me whether it looks ok. Thanks!

Copy link
Collaborator

@heuels heuels left a comment

Choose a reason for hiding this comment

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

@felixfontein, looks awesome, thank you for this!

One thing I'd add is a note about long commands or long router identities, as seen here.

@felixfontein
Copy link
Collaborator Author

@heuels good point! I mentioned some of these problems in 269e689.

@felixfontein felixfontein mentioned this pull request Jun 22, 2021
@felixfontein felixfontein merged commit 39dcf4a into ansible-collections:main Jun 23, 2021
@felixfontein felixfontein deleted the docs branch June 23, 2021 19:18
@felixfontein
Copy link
Collaborator Author

@heuels thanks for reviewing this!

Copy link
Collaborator

@NikolayDachev NikolayDachev left a comment

Choose a reason for hiding this comment

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

Nice :)

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.

3 participants