summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorajax <ajax@980ebf18-57e1-0310-9a29-db15c13687c0>2006-10-12 15:58:16 +0000
committerajax <ajax@980ebf18-57e1-0310-9a29-db15c13687c0>2006-10-12 15:58:16 +0000
commitba33249e5fcd3c3818b4ccc0ce884d46b6db6408 (patch)
tree37dcdbf81d61df27f67d5dae8f132ed8be7c2b0b /documentation
parentda7cb9fc2339cea48d727a6256b1a66769b14af0 (diff)
downloadpuppet-ba33249e5fcd3c3818b4ccc0ce884d46b6db6408.tar.gz
puppet-ba33249e5fcd3c3818b4ccc0ce884d46b6db6408.tar.xz
puppet-ba33249e5fcd3c3818b4ccc0ce884d46b6db6408.zip
New documentation hierarchy.
git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1771 980ebf18-57e1-0310-9a29-db15c13687c0
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Rakefile4
-rw-r--r--documentation/documentation/about/introduction.page (renamed from documentation/documentation/introduction.page)3
-rw-r--r--documentation/documentation/about/notcfengine.page (renamed from documentation/documentation/notcfengine.page)0
-rw-r--r--documentation/documentation/advanced/cfengine_module.page (renamed from documentation/documentation/cfengine_module.page)1
-rw-r--r--documentation/documentation/advanced/ldapnodes.page (renamed from documentation/documentation/ldapnodes.page)7
-rw-r--r--documentation/documentation/advanced/puppetshow.page (renamed from documentation/documentation/puppetshow.page)5
-rw-r--r--documentation/documentation/advanced/reports.page (renamed from documentation/documentation/reports.page)7
-rw-r--r--documentation/documentation/advanced/tags.page (renamed from documentation/documentation/tags.page)6
-rw-r--r--documentation/documentation/advanced/templating.page (renamed from documentation/documentation/templating.page)5
-rw-r--r--documentation/documentation/installing/fromsvn.page (renamed from documentation/documentation/fromsvn.page)4
-rw-r--r--documentation/documentation/installing/fsconfigref.page (renamed from documentation/documentation/fsconfigref.page)4
-rw-r--r--documentation/documentation/installing/installation.page (renamed from documentation/documentation/installation.page)3
-rw-r--r--documentation/documentation/installing/security.page (renamed from documentation/documentation/security.page)3
-rw-r--r--documentation/documentation/installing/testing.page (renamed from documentation/documentation/testing.page)4
-rw-r--r--documentation/documentation/internals/big-picture.page (renamed from documentation/documentation/big-picture.page)5
-rw-r--r--documentation/documentation/internals/howitworks.page (renamed from documentation/documentation/howitworks.page)4
-rw-r--r--documentation/documentation/language/languagetutorial.page (renamed from documentation/documentation/languagetutorial.page)4
-rw-r--r--documentation/documentation/language/structures.page (renamed from documentation/documentation/structures.page)3
-rw-r--r--documentation/documentation/programmers/creating-a-puppet-type.page (renamed from documentation/documentation/creating-a-puppet-type.page)4
-rw-r--r--documentation/documentation/reference/configref.page (renamed from documentation/documentation/configref.page)2
-rw-r--r--documentation/documentation/reference/typedocs.page (renamed from documentation/documentation/typedocs.page)2
21 files changed, 43 insertions, 37 deletions
diff --git a/documentation/Rakefile b/documentation/Rakefile
index 2bdc11d6f..a2d36fa56 100644
--- a/documentation/Rakefile
+++ b/documentation/Rakefile
@@ -33,6 +33,6 @@ task :html => htmlfiles
task :default => :html
task :docs do
- sh %{puppetdoc --arguments > documentation/configref.page}
- sh %{puppetdoc --types > documentation/typedocs.page}
+ sh %{puppetdoc --arguments > documentation/reference/configref.page}
+ sh %{puppetdoc --types > documentation/reference/typedocs.page}
end
diff --git a/documentation/documentation/introduction.page b/documentation/documentation/about/introduction.page
index e112d8dab..dd99c488c 100644
--- a/documentation/documentation/introduction.page
+++ b/documentation/documentation/about/introduction.page
@@ -1,6 +1,7 @@
---
inMenu: true
-orderInfo: 2
+title: Introduction
+orderInfo: 10
---
# Introduction
diff --git a/documentation/documentation/notcfengine.page b/documentation/documentation/about/notcfengine.page
index 7f36de2c3..7f36de2c3 100644
--- a/documentation/documentation/notcfengine.page
+++ b/documentation/documentation/about/notcfengine.page
diff --git a/documentation/documentation/cfengine_module.page b/documentation/documentation/advanced/cfengine_module.page
index 824159bcd..b809323a8 100644
--- a/documentation/documentation/cfengine_module.page
+++ b/documentation/documentation/advanced/cfengine_module.page
@@ -3,6 +3,7 @@ inMenu: true
title: Cfengine Module
orderInfo: 10
---
+# Cfengine Module
For those who are still using Cfengine but would like either to take advantage
of Puppet's greater abstractive or modeling capabilities, we have created a
diff --git a/documentation/documentation/ldapnodes.page b/documentation/documentation/advanced/ldapnodes.page
index 388706191..1623f9c20 100644
--- a/documentation/documentation/ldapnodes.page
+++ b/documentation/documentation/advanced/ldapnodes.page
@@ -1,10 +1,9 @@
---
inMenu: true
-title: LDAP Node Storage
-orderInfo: 10
+title: Storing Configs in LDAP
+orderInfo: 50
---
-
-# Storing Node Information in LDAP
+# Storing Configs in LDAP
By default, ``puppetmasterd`` looks for nodes in its normal manifests, but you
can instead have it look in LDAP. This works especially well if you are
diff --git a/documentation/documentation/puppetshow.page b/documentation/documentation/advanced/puppetshow.page
index 41a882037..00a0ad8fb 100644
--- a/documentation/documentation/puppetshow.page
+++ b/documentation/documentation/advanced/puppetshow.page
@@ -1,8 +1,9 @@
---
inMenu: true
-title: PuppetShow
-orderInfo: 10
+title: Managing Puppet with PuppetShow
+orderInfo: 50
---
+# Managing Puppet with PuppetShow
I have begun work on a simplistic web-based Puppet manager based on
[Rails](http://rubyonrails.org), called PuppetShow. It's in a very primitive
diff --git a/documentation/documentation/reports.page b/documentation/documentation/advanced/reports.page
index dee892ac8..c9fe470a7 100644
--- a/documentation/documentation/reports.page
+++ b/documentation/documentation/advanced/reports.page
@@ -1,10 +1,9 @@
---
inMenu: true
-title: Reports and Reporting
-orderInfo: 10
+title: Transaction Reporting
+orderInfo: 50
---
-
-# Reports and Reporting
+# Transaction Reporting
Puppet can be configured to run specialized reports to help you to better keep track of your configurations.
diff --git a/documentation/documentation/tags.page b/documentation/documentation/advanced/tags.page
index 8ac89b0b8..fdebf3d9b 100644
--- a/documentation/documentation/tags.page
+++ b/documentation/documentation/advanced/tags.page
@@ -1,9 +1,9 @@
---
inMenu: true
-title: Gaining More Control with Tags
-orderInfo: 10
+title: Using Tags
+orderInfo: 50
---
-# Gaining More Control with Tags
+# Using Tags
Puppet allows for arbitrary tags to be applied to any or all objects in its configuration. You can use these tags to control your configuration roll-out with greater precision or greater complexity.
diff --git a/documentation/documentation/templating.page b/documentation/documentation/advanced/templating.page
index 73865429d..82de96272 100644
--- a/documentation/documentation/templating.page
+++ b/documentation/documentation/advanced/templating.page
@@ -1,7 +1,10 @@
---
inMenu: true
-orderInfo: 10
+title: Templating with ERB
+orderInfo: 50
---
+# Templating with ERB
+
Puppet supports templating via
[ERB](http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/), which is part of the
Ruby standard library and is used for many other projects including Ruby on
diff --git a/documentation/documentation/fromsvn.page b/documentation/documentation/installing/fromsvn.page
index 243d46fa0..ac86e60a1 100644
--- a/documentation/documentation/fromsvn.page
+++ b/documentation/documentation/installing/fromsvn.page
@@ -1,7 +1,7 @@
---
inMenu: true
-title: Using Source
-orderInfo: 10
+title: Building from Source
+orderInfo: 20
---
Puppet is currently implemented in Ruby and uses standard Ruby libraries. You
should be able to run Puppet on any Unix-style host with Ruby. Windows
diff --git a/documentation/documentation/fsconfigref.page b/documentation/documentation/installing/fsconfigref.page
index dca390cd8..b9cedb111 100644
--- a/documentation/documentation/fsconfigref.page
+++ b/documentation/documentation/installing/fsconfigref.page
@@ -1,7 +1,7 @@
---
inMenu: true
-title: Fileserver Reference
-orderInfo: 8
+title: Fileserver Configuration
+orderInfo: 20
---
# FileServer
diff --git a/documentation/documentation/installation.page b/documentation/documentation/installing/installation.page
index 53f7e92c2..97908703c 100644
--- a/documentation/documentation/installation.page
+++ b/documentation/documentation/installing/installation.page
@@ -1,6 +1,7 @@
---
inMenu: true
-orderInfo: 3
+title: Installation
+orderInfo: 20
---
# Comments
diff --git a/documentation/documentation/security.page b/documentation/documentation/installing/security.page
index e3680686d..9f94cc5f4 100644
--- a/documentation/documentation/security.page
+++ b/documentation/documentation/installing/security.page
@@ -1,6 +1,7 @@
---
inMenu: true
-orderInfo: 10
+title: SSL Configuration
+orderInfo: 20
---
# Overview
diff --git a/documentation/documentation/testing.page b/documentation/documentation/installing/testing.page
index 1f1ba9ba9..1e29e9953 100644
--- a/documentation/documentation/testing.page
+++ b/documentation/documentation/installing/testing.page
@@ -1,7 +1,7 @@
---
inMenu: true
-title: Testing
-orderInfo: 10
+title: Test-driving Puppet
+orderInfo: 20
---
If you want to just test-drive Puppet, making the least commitment possible,
diff --git a/documentation/documentation/big-picture.page b/documentation/documentation/internals/big-picture.page
index a492c30ab..31aaa0e74 100644
--- a/documentation/documentation/big-picture.page
+++ b/documentation/documentation/internals/big-picture.page
@@ -1,10 +1,9 @@
---
inMenu: true
title: The Big Picture
-orderInfo: 10
+orderInfo: 60
---
-
-# Big picture
+# Big Picture
Puppet is a **declarative language** for expressing system configuration, a
**client and server** for distributing it, and a **library** for realizing the
diff --git a/documentation/documentation/howitworks.page b/documentation/documentation/internals/howitworks.page
index a686c4c90..3a101745c 100644
--- a/documentation/documentation/howitworks.page
+++ b/documentation/documentation/internals/howitworks.page
@@ -1,9 +1,9 @@
---
inMenu: true
title: How It Works
-orderInfo: 9
+orderInfo: 60
---
-# Introduction
+# How it Works: Introduction
The goal of this document is to describe how a manifest you write in Puppet
gets converted to work being done on the system. This process is relatively
diff --git a/documentation/documentation/languagetutorial.page b/documentation/documentation/language/languagetutorial.page
index ccac0fc34..d5c067a5b 100644
--- a/documentation/documentation/languagetutorial.page
+++ b/documentation/documentation/language/languagetutorial.page
@@ -1,7 +1,7 @@
---
inMenu: true
-title: Language Tutorial
-orderInfo: 5
+title: Puppet Language Tutorial
+orderInfo: 30
---
# Elements and Organization
diff --git a/documentation/documentation/structures.page b/documentation/documentation/language/structures.page
index 6ee99607f..8c7cb030b 100644
--- a/documentation/documentation/structures.page
+++ b/documentation/documentation/language/structures.page
@@ -1,6 +1,7 @@
---
inMenu: true
-orderInfo: 10
+title: Control Structures
+orderInfo: 30
---
This is a brief overview of the language structures
diff --git a/documentation/documentation/creating-a-puppet-type.page b/documentation/documentation/programmers/creating-a-puppet-type.page
index 2ca27c842..9ee6ae99f 100644
--- a/documentation/documentation/creating-a-puppet-type.page
+++ b/documentation/documentation/programmers/creating-a-puppet-type.page
@@ -1,7 +1,7 @@
---
inMenu: true
-title: Custom Types
-orderInfo: 7
+title: Creating Custom Types
+orderInfo: 70
---
# Organizational Principles
diff --git a/documentation/documentation/configref.page b/documentation/documentation/reference/configref.page
index 007965d9e..d31442d40 100644
--- a/documentation/documentation/configref.page
+++ b/documentation/documentation/reference/configref.page
@@ -1,7 +1,7 @@
---
inMenu: true
title: Configuration Reference
-orderInfo: 6
+orderInfo: 30
---
# Puppet Configuration Reference
diff --git a/documentation/documentation/typedocs.page b/documentation/documentation/reference/typedocs.page
index cddbd5c7a..c928e5e92 100644
--- a/documentation/documentation/typedocs.page
+++ b/documentation/documentation/reference/typedocs.page
@@ -1,7 +1,7 @@
---
inMenu: true
title: Type Reference
-orderInfo: 4
+orderInfo: 30
---
# Type Reference