Document new UI that allows importing/overriding Ansible variables from YAML files in foreman_ansible. #2941
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: |
ekohl
left a comment
ekohl
left a comment
There was a problem hiding this comment.
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
| . 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.
| 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.
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
pr-processor
bot
added
Waiting on contributor
Thorben-D
force-pushed
the
issue/OR-4615_ansible_variables_yaml_doc_upstream
branch
from
5c9b6b7 to
93d6143
Compare
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
Thorben-D
left a comment
Thorben-D
left a comment
There was a problem hiding this comment.
@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.
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.
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.
Thorben-D
force-pushed
the
issue/OR-4615_ansible_variables_yaml_doc_upstream
branch
from
93d6143 to
beaad55
Compare
maximiliankolb
deleted the
issue/OR-4615_ansible_variables_yaml_doc_upstream
branch
3 participants
This PR adds documentation for theforeman/foreman_ansible#707