Rudder

Clean foswiki.¶

It still contains outdated content like http://www.rudder-project.org/foswiki/Download/WebHome which is the second Google result for "Download Rudder".

Could be the first page of the manual.

Add a getting started section¶

At the very beginning of the manual. It should follow a simple scenario from the beginning to the end (like a web platform installation), to help discover Rudder workflow.

• Installation of a demo platform ("getting started" on normation.com)
• Basic node management, quick explanation of the concepts
• Create directives (built-in+technique editor, with file copy, templating), rules, quick explanation of the concepts.
• Basic agent commands
• etc.
• This chapter should include a lot of screenshots and tips.

We should probably initially target this section to 3.1.

Split the "Introduction" chapter¶

• Move things to the Reference chapter (dependency graph, list of Rudder packages)
• Replace texts by schema and diagrams
• Move to "Requirements" part into the Installation chapter

Split the "Advanced usage" chapter¶

• Move all administration elements (multi server, relays) into "Administration"
• Rename it "Advanced Configuration Management" (with technique creation)

Integrate the "Handbook" into Administration¶

Add "Troubleshooting" and "Known issues" sections¶

• Integrate the relevant content from the FAQ
• troubleshooting workflow (rudder server debug, relevant logfiles, etc.)
• known issues like limitations of ncf reporting, etc.

Have a better indexing policy¶

For now the first result in Google is the 2.3 doc, we should probably only have one indexable version.

Add a section in administration about integration with other tools¶

• monitoring Rudder
  • document log files to check for errors
  • the format of non-compliance-reports.log
  • hexample of compliance API
  • give an example of logstash grok for non-compliance
  • rudder agent health on 3.3.
• how to use the API to integrate with Rundeck, Ansible, etc.