Page MenuHomeDevCentral

Document salt-wrapper
ClosedPublic

Authored by dereckson on Oct 3 2017, 21:12.
Tags
None
Referenced Files
F7645148: D1024.id2612.diff
Wed, Apr 30, 08:15
F7641664: D1024.id2618.diff
Wed, Apr 30, 06:15
F7621362: D1024.id2617.diff
Tue, Apr 29, 21:34
F7618093: D1024.id2616.diff
Tue, Apr 29, 19:39
F7617004: D1024.id2613.diff
Tue, Apr 29, 19:13
F7610344: D1024.id.diff
Tue, Apr 29, 16:39
Unknown Object (File)
Mon, Apr 28, 20:03
Unknown Object (File)
Mon, Apr 28, 14:01
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
Lint Not Applicable
Unit
Tests Not Applicable

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.