Skip to content

Clarify and beautify Provider reference documentation #232

@blindzero

Description

@blindzero

Description

Current Provider is a little unstructured with

  • "Inputs (With.*)" after "Description" but description only containing all info on the single Inputs.
  • this should be separated. Description really only containing (longer) description and reference of the With.* Option's content and Parameters directly in With.*
  • This content is not really formatted nor has technical additional information of the type, syntax etc.
  • Example should also contain these options, not only With.* first level; consider different examples, e.g. by sourcing the example/template files

Steps to Reproduce

Look at https://blindzero.github.io/IdentityLifecycleEngine/docs/reference/steps/step-mailbox-ensure-permissions#inputs-with

Additional Context

The result of the new template structure should also be committed to the template file for provider reference documentation.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestprio:mediumtype:docsImprovements or additions to documentation.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions