Add playbook docs #86
Merged
Conversation
This file contains 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
hakbailey
force-pushed
the
add-playbook-docs
branch
3 times, most recently
from
46aecb8
to
dacdbaa
Compare
ansible-rulebook cannot currently find playbooks in subdirectories under the playbooks directory when calling them using FQCN. Moving the rulebook to the recommended extensions/eda/rulebooks directory requires that we call playbooks via FQCN since we also cannot use relative paths (ansible-rulebook interprets relative paths from the working directory where ansible-rulebook is called, not from the rulebook location).
hakbailey
force-pushed
the
add-playbook-docs
branch
from
dacdbaa
to
f959688
Compare
There was a problem hiding this comment.
Hi @hakbailey , I was wondering if it would be a good idea to add the data type of the playbook variables to the READMEs inside the playbooks folder. It could help users better understand what types of data they can use and how to properly format it. What do you think?
Yeah I think that's a great idea! Will add. |
GomathiselviS
approved these changes
Aug 24, 2023
gravesm
approved these changes
Aug 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 goal for this PR was to add documentation for the playbooks and rulebooks in this repo, which is included. As part of that documentation, some bugs were found and addressed to ensure the playbooks and rulebooks work as documented.
ISSUE TYPE