foreman-documentation icon indicating copy to clipboard operation
foreman-documentation copied to clipboard

Reword snippet to run custom code before/after host provisioning

Open maximiliankolb opened this issue 7 months ago • 0 comments

          The title strikes me as odd. Shouldn't we tell the user the use case, rather than the means to do it? I suggest a title such as "Running custom code while provisioning hosts". I know that the custom code is run before or after provisioning, but I think that this works for a title.

Then I would expect a lead-in sentence: "You can run custom code before or after provisioning the host by creating a custom provisioning snippet."

I can't recall the exact source but I was taught not to use 'and/or' because this construction can cause translation issues. It is also ambiguous. The user has to figure out whether you mean 'before and after', 'before or after', or 'before, after, or both'.

Originally posted by @apinnick in https://github.com/theforeman/foreman-documentation/pull/3164#discussion_r1694177435

maximiliankolb avatar Jul 29 '24 13:07 maximiliankolb