graphite-dev team mailing list archive

[Drew Stephens <drew@xxxxxxxxxxxx>]

Drew Stephens has proposed merging lp:~dinomite/graphite/documentation into lp:graphite.

Requested reviews:
  graphite-dev (graphite-dev)

For more details, see:
https://code.launchpad.net/~dinomite/graphite/documentation/+merge/74658

Some documentation clarification.
-- 
https://code.launchpad.net/~dinomite/graphite/documentation/+merge/74658
Your team graphite-dev is requested to review the proposed merge of lp:~dinomite/graphite/documentation into lp:graphite.

=== modified file 'docs/Makefile'
--- docs/Makefile	2011-03-21 17:33:50 +0000
+++ docs/Makefile	2011-09-08 17:56:23 +0000
@@ -2,10 +2,10 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = _build
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+PAPER         ?=
+BUILDDIR      ?= _build
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4

=== modified file 'docs/admin-carbon.rst'
--- docs/admin-carbon.rst	2011-03-21 20:22:09 +0000
+++ docs/admin-carbon.rst	2011-09-08 17:56:23 +0000
@@ -1,2 +1,13 @@
 Administering Carbon
 ====================
+
+
+Starting Carbon
+---------------
+Carbon can be started with the ``carbon-cache.py`` script::
+
+    /opt/graphite/bin/carbon-cache.py start
+
+This starts the main Carbon daemon in the background.  Now is a good time
+to check the logs, located in ``/opt/graphite/storage/log/carbon-cache/``
+for any errors.

=== modified file 'docs/config-carbon.rst'
--- docs/config-carbon.rst	2011-08-10 21:14:58 +0000
+++ docs/config-carbon.rst	2011-09-08 17:56:23 +0000
@@ -2,7 +2,7 @@
 ==================
 
 Carbon's config files all live in ``/opt/graphite/conf/``. If you've just installed Graphite, none of the ``.conf`` files will
-exist yet, but there will be a ``.conf.example`` file for each one. Simply copy the example files and customize your settings.
+exist yet, but there will be a ``.conf.example`` file for each one. Simply copy the example files, removing the .example extension, and customize your settings.
 
 
 carbon.conf

=== modified file 'docs/install.rst'
--- docs/install.rst	2011-08-24 07:06:40 +0000
+++ docs/install.rst	2011-09-08 17:56:23 +0000
@@ -95,32 +95,27 @@
 
 Post-Install Tasks
 ------------------
-Once you've installed everything you will need to create some basic configuration.
-Initially none of the config files are created by the installer but example files
-are provided. Simply copy the ``.example`` files and customize.
 
 :doc:`Configuring Carbon </config-carbon>`
-
-Once Carbon is configured, you need to start it up.
+    Once you've installed everything you will need to create some basic configuration.
+    Initially none of the config files are created by the installer but example files
+    are provided. Simply copy the ``.example`` files and customize.
 
 :doc:`Administering Carbon </admin-carbon>`
-
-Once it's up and running, you need to feed it some data.
+    Once Carbon is configured, you need to start it up.
 
 :doc:`Feeding In Your Data </feeding-carbon>`
-
-Once you're feeding in data, you probably want to look at graphs of it. So now
-we turn our attention to the webapp.
+    Once it's up and running, you need to feed it some data.
 
 :doc:`Configuring The Webapp </config-webapp>`
-
-Once its configured you'll need to get it running.
+    With data getting into carbon, you probably want to look at graphs of it.
+    So now we turn our attention to the webapp.
 
 :doc:`Administering The Webapp </admin-webapp>`
-
-Now that the webapp is running, you probably want to learn how to use it.
+    Once its configured you'll need to get it running.
 
 :doc:`Using the Composer </composer>`
+    Now that the webapp is running, you probably want to learn how to use it.
 
 That covers the basics, the next thing you should probably read about is
 :doc:`The URL API </url-api>`.