Skip to content

Commit

Permalink
Work in progress
Browse files Browse the repository at this point in the history
  • Loading branch information
amousset committed Jul 18, 2018
1 parent 7e2de67 commit c8ba334
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion src/reference/modules/ROOT/pages/index.adoc
@@ -1 +1,40 @@
= Rudder reference documentation
= Welcome to Rudder User Documentation

Rudder is an easy to use, web-driven, role-based solution for IT Infrastructure Automation and Compliance.
Getting Started

If you are new to Rudder you can follow these steps to discover and start using Rudder:

* Read about xref:00_introduction/01_presentation.adoc#what-is-rudder[what is Rudder], which are its xref:00_introduction/20_key_features.adoc#key-features[key features] and technical xref:00_introduction/40_architecture_and_dependencies.adoc#architecture[architecture].
* Follow the installation section which explains the requirements and the installation steps for the different types of nodes:
** The central server
** The (optional) relays
** The managed nodes
* Learn how to use the Web interface, to manage nodes and to configure them.
== Resources

Besides this documentation, you can find a lot of other useful information:

* The Changelog for this version. It describes the changes in each release.
* The Rudder project website
* The FAQ, particularly:
** What is an ESR version? How long are Rudder versions supported? All the answers are in the versionning policy
* You need help or have questions about Rudder? You can:
** Look for an existing answer in the FAQ
** Send an email to the user mailing-list
** Join the IRC channel
* You need training, or commercial support? Normation provides services for Rudder
* Browse the contribution documentation if you want to help improve Rudder

[TIP]

====
About this documentation
You can browse this documentation using the left tree, or use the search field in the header bar. It is also embedded in the Rudder server Web interface for offline usage.
If you find any issue, lacking information, or if you have a suggestion, open an issue in our bugtracker.
====

0 comments on commit c8ba334

Please sign in to comment.