Page MenuHomeDevCentral

Document salt-wrapper
ClosedPublic

Authored by dereckson on Oct 3 2017, 21:12.
Tags
None
Referenced Files
F54154115: D1024.id2617.diff
Thu, Oct 15, 09:42
F54154106: D1024.id2612.diff
Thu, Oct 15, 09:42
F54154103: D1024.id2613.diff
Thu, Oct 15, 09:42
F54151081: D1024.diff
Thu, Oct 15, 08:56
F54147609: D1024.id2616.diff
Thu, Oct 15, 08:06
F54147608: D1024.id2618.diff
Thu, Oct 15, 08:06
F54142810: D1024.id2613.diff
Thu, Oct 15, 07:04
F54142807: D1024.id2612.diff
Thu, Oct 15, 07:04
Subscribers
None

Details

Summary

The documentation is divided in two parts:

  • an admin manual to cover installation and configuration
  • an user manual to explain how to use and troubleshoot it

A contributor part could be added in the future,
especially if we prepare a rst generic document
explaining how to contribute to Nasqueron projects.

Test Plan
  • cd docs && make html
  • proofread the generated documentation

Diff Detail

Repository
rSW salt-wrapper
Lint
No Lint Coverage
Unit
No Test Coverage
Branch
docs
Build Status
Buildable 1610
Build 1858: arc lint + arc unit

Event Timeline

dereckson added inline comments.
docs/admin.rst
106

Can now be customized in environment with the SALT_WRAPPER_CONF variable.

dereckson marked an inline comment as done.

Document SALT_WRAPPER_CONF.

This revision is now accepted and ready to land.Oct 4 2017, 12:16
This revision was automatically updated to reflect the committed changes.