doc/topics/development/conventions/formulas.rst ID Naming Standard

[damon-atkins]

Description of Issue/Question

doc/topics/development/conventions/formulas.rst needs to talk more about suggested ID Naming Standard for https://github.com/saltstack-formulas e.g if everyone used install_pkg for an ID salt would fail.

It needs to provide guidance on naming the ID. e.g.

• prefix with formula state name
• use suffix with formula state name
  etc

[gtmanfred]

That would be great to have. We should formalize this so that we can avoid naming conflicts in formulas

[damon-atkins]

Few extra thoughts.
E.g. https://github.com/saltstack-formulas/ <name>-forumula

• <name> is the name of the state.
• <name> is the prefix for all pillars
• <name> is the prefix for all ID's

Is _ or . or something else to be the separator?

Except for a file, which is replaced can use the filename as the ID. Because two states can not mange the same file. e.g. file.absent, file.managed.

Not sure if salt errors when two different file.managed battle it out for the same file. I should try it out see what happens.

I will leave it to SaltStack to decide and doco. I thought it should be good to standardised in some shape or form to stop ID clashes.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

[stale]

Thank you for updating this issue. It is no longer marked as stale.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

[stale]

Thank you for updating this issue. It is no longer marked as stale.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

[stale]

Thank you for updating this issue. It is no longer marked as stale.