doc/index.rst: add link to Dev Guide basic workfl.

This PR adds a link to the "Basic Workflow" section of the
Developer Guide on the landing page of docs.ceph.com.

This PR is meant to improve the documentation for developers
new to Ceph and to guide them to instructions that will allow
them to become full-fledged contributors to the Ceph project
as quickly as possible.

The "Basic Workflow" page of the Developer Guide contains
information that answers almost all of the questions that I had
about contributing to the Ceph project when I was new to it,
and I am finally acting on my long-held conviction that the
"Basic Workflow" page of the Developer Guide should have a more
prominent position in the documentation suite than it has had.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit c624a2a8ef71035eef34ee866ef7668f83a139e7)

diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst
index 9eff4b7abb07533f5478f1f3c3e37643c4504a8e..fbc9431033e4146fc43f85ab25a7e7e9e000b19e 100644 (file)
--- a/doc/dev/developer_guide/basic-workflow.rst
+++ b/doc/dev/developer_guide/basic-workflow.rst
@@ -1,3 +1,5 @@
+.. _basic workflow dev guide:
+
 Basic Workflow
 ==============
 

diff --git a/doc/index.rst b/doc/index.rst
index 19b5fba875f85cb159a1ec167ec00ce678442a10..4596f31c087b0d7e84c00965187a299dcbe6e148 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -5,10 +5,18 @@
 Ceph uniquely delivers **object, block, and file storage in one unified
 system**.
 
+.. warning:: 
+
+   :ref:`If this is your first time using Ceph, read the "Basic Workflow" 
+   page in the Ceph Developer Guide to learn how to contribute to the 
+   Ceph project. (Click anywhere in this paragraph to read the "Basic 
+   Workflow" page of the Ceph Developer Guide.) <basic workflow dev guide>`.
+
 .. raw:: html
 
-       <style type="text/css">div.body h3{margin:5px 0px 0px 0px;}</style>
-       <table cellpadding="10"><colgroup><col width="33%"><col width="33%"><col width="33%"></colgroup><tbody valign="top"><tr><td><h3>Ceph Object Store</h3>
+      <style type="text/css">div.body h3{margin:5px 0px 0px 0px;}</style>
+      <table cellpadding="10"><colgroup><col width="33%"><col width="33%">
+      <col width="33%"></colgroup><tbody valign="top"><tr><td><h3>Ceph Object Store</h3>
 
 - RESTful Interface
 - S3- and Swift-compliant APIs