-
Notifications
You must be signed in to change notification settings - Fork 95
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
Document new UI that allows importing/overriding Ansible variables from YAML files in foreman_ansible. #2941
base: master
Are you sure you want to change the base?
Conversation
The PR preview for beaad55 is available at theforeman-foreman-documentation-preview-pr-2941.surge.sh The following output files are affected by this PR: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you link to where this was implemented? That makes it easier to cross reference.
@ekohl |
guides/common/modules/proc_importing-ansible-variables-from-yaml.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_importing-ansible-variables-from-yaml.adoc
Outdated
Show resolved
Hide resolved
. Click *Import from YAML-File* in the toolbar. | ||
+ | ||
A wizard opens to show you the next steps to import/override Ansible variables. | ||
Ensure variables are unique per role. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ensure variables are unique per role. | |
Ensure that variables are unique per Ansible role. |
What happens if they're not?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In case a variable is present > 1 times in the UI, i.e.:
- var0 <--
- var1
- var2
- var0 <--
the user is not allowed to continue, as that would make the variable ambiguous.
If a variable is present that has been imported earlier, the user may proceed, but must understand that the variable's type and default value will be overridden.
Appropriate warnings are shown in both cases.
guides/common/modules/proc_importing-ansible-variables-from-yaml.adoc
Outdated
Show resolved
Hide resolved
5c9b6b7
to
93d6143
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@maximiliankolb
I addressed the issues and clarified "uniqueness".
. Click *Import from YAML-File* in the toolbar. | ||
+ | ||
A wizard opens to show you the next steps to import and override Ansible variables. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line basically tells the user to just "follow the wizard". This was done in light of #2490.
Since my wizard also contains helpertexts and is laid out in a generally self-explanatory fashion, I found it fitting.
For the wording, I oriented myself towards:
https://github.com/theforeman/foreman-documentation/blob/master/guides/common/modules/con_standardizing-content-view-empty-states.adoc?plain=1#L6
. Click *Import from YAML-File* in the toolbar. | ||
+ | ||
A wizard opens to show you the next steps to import/override Ansible variables. | ||
Ensure variables are unique per role. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In case a variable is present > 1 times in the UI, i.e.:
- var0 <--
- var1
- var2
- var0 <--
the user is not allowed to continue, as that would make the variable ambiguous.
If a variable is present that has been imported earlier, the user may proceed, but must understand that the variable's type and default value will be overridden.
Appropriate warnings are shown in both cases.
…om YAML-files in foreman_ansible.
93d6143
to
beaad55
Compare
This PR adds documentation for theforeman/foreman_ansible#707