You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by su...@apache.org on 2019/03/05 18:21:28 UTC
[incubator-pinot] branch master updated: Update read-the-docs high
level organization. More changes to follow (#3906)
This is an automated email from the ASF dual-hosted git repository.
sunithabeeram pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git
The following commit(s) were added to refs/heads/master by this push:
new ec22501 Update read-the-docs high level organization. More changes to follow (#3906)
ec22501 is described below
commit ec22501cd8ddfa50b09f702cb9852820493ebe17
Author: Sunitha Beeram <sb...@linkedin.com>
AuthorDate: Tue Mar 5 10:21:22 2019 -0800
Update read-the-docs high level organization. More changes to follow (#3906)
---
docs/{reference.rst => README} | 14 ++++----------
docs/{reference.rst => admin_guide.rst} | 10 ++++------
docs/{reference.rst => code_modues.rst} | 12 ++----------
docs/coding_guidelines.rst | 17 -----------------
docs/{reference.rst => customizations.rst} | 11 ++---------
docs/{coding_guidelines.rst => dev_env.rst} | 12 ++----------
docs/{reference.rst => dev_guide.rst} | 11 ++++-------
docs/{reference.rst => extensions.rst} | 12 ++++++------
docs/{reference.rst => getting_involved.rst} | 8 --------
docs/{trying_pinot.rst => getting_started.rst} | 4 ++--
docs/index.rst | 25 +++++++++++++++----------
docs/index_techniques.rst | 1 +
docs/{reference.rst => tuning_pinot.rst} | 8 +++-----
docs/{reference.rst => user_guide.rst} | 6 +-----
14 files changed, 46 insertions(+), 105 deletions(-)
diff --git a/docs/reference.rst b/docs/README
similarity index 82%
copy from docs/reference.rst
copy to docs/README
index bb6891f..0e41afc 100644
--- a/docs/reference.rst
+++ b/docs/README
@@ -17,13 +17,7 @@
.. under the License.
..
-.. _reference:
-
-.. toctree::
- :maxdepth: 1
-
- pql_examples
- index_techniques
- client_api
- management_api
- pinot_hadoop
+Updating the docs:
+1. Edit or add files as needed.
+2. Run "make html"
+3. Open _build/html/index.html in your favorite browser and ensure contents and links work correctly.
\ No newline at end of file
diff --git a/docs/reference.rst b/docs/admin_guide.rst
similarity index 91%
copy from docs/reference.rst
copy to docs/admin_guide.rst
index bb6891f..ba01ece 100644
--- a/docs/reference.rst
+++ b/docs/admin_guide.rst
@@ -17,13 +17,11 @@
.. under the License.
..
-.. _reference:
-
.. toctree::
:maxdepth: 1
- pql_examples
- index_techniques
- client_api
+ in_production
management_api
- pinot_hadoop
+ multitenancy
+ customizations
+ tuning_pinot
diff --git a/docs/reference.rst b/docs/code_modues.rst
similarity index 86%
copy from docs/reference.rst
copy to docs/code_modues.rst
index bb6891f..e3a503c 100644
--- a/docs/reference.rst
+++ b/docs/code_modues.rst
@@ -17,13 +17,5 @@
.. under the License.
..
-.. _reference:
-
-.. toctree::
- :maxdepth: 1
-
- pql_examples
- index_techniques
- client_api
- management_api
- pinot_hadoop
+Code Modules and organization
+=============================
diff --git a/docs/coding_guidelines.rst b/docs/coding_guidelines.rst
index 3c415d6..2432276 100644
--- a/docs/coding_guidelines.rst
+++ b/docs/coding_guidelines.rst
@@ -19,23 +19,6 @@
Coding Guidelines
=================
-
-To contribute to Pinot, please follow the code-style as described below:
-
-Intellij
-^^^^^^^^
-
-* `Import <https://www.jetbrains.com/help/idea/settings-code-style.html>`_ code style to Intellij
-* Navigate to ``Preferences`` -> ``Editor`` -> ``Code Style`` -> ``Java``
-* Select ``Import Scheme`` -> ``Intellij IDES code style XML``
-* Choose ``codestyle-intellij.xml``
-
-Eclipse
-^^^^^^^
-.. todo::
-
- Add instructions for eclipse here
-
Verifying code-style
^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/reference.rst b/docs/customizations.rst
similarity index 86%
copy from docs/reference.rst
copy to docs/customizations.rst
index bb6891f..3852028 100644
--- a/docs/reference.rst
+++ b/docs/customizations.rst
@@ -17,13 +17,6 @@
.. under the License.
..
-.. _reference:
-.. toctree::
- :maxdepth: 1
-
- pql_examples
- index_techniques
- client_api
- management_api
- pinot_hadoop
+Customization points in Pinot
+=============================
\ No newline at end of file
diff --git a/docs/coding_guidelines.rst b/docs/dev_env.rst
similarity index 86%
copy from docs/coding_guidelines.rst
copy to docs/dev_env.rst
index 3c415d6..5292703 100644
--- a/docs/coding_guidelines.rst
+++ b/docs/dev_env.rst
@@ -17,8 +17,8 @@
.. under the License.
..
-Coding Guidelines
-=================
+Dev Environment Setup
+=====================
To contribute to Pinot, please follow the code-style as described below:
@@ -36,12 +36,4 @@ Eclipse
Add instructions for eclipse here
-Verifying code-style
-^^^^^^^^^^^^^^^^^^^^
-
-Run the following command to verify the code-style before posting a PR
-
-.. code-block:: none
-
- mvn checkstyle:check
diff --git a/docs/reference.rst b/docs/dev_guide.rst
similarity index 89%
copy from docs/reference.rst
copy to docs/dev_guide.rst
index bb6891f..6c76e3b 100644
--- a/docs/reference.rst
+++ b/docs/dev_guide.rst
@@ -17,13 +17,10 @@
.. under the License.
..
-.. _reference:
-
.. toctree::
:maxdepth: 1
- pql_examples
- index_techniques
- client_api
- management_api
- pinot_hadoop
+ dev_env
+ coding_guidelines
+ code_modules
+ extensions
diff --git a/docs/reference.rst b/docs/extensions.rst
similarity index 79%
copy from docs/reference.rst
copy to docs/extensions.rst
index bb6891f..43872b8 100644
--- a/docs/reference.rst
+++ b/docs/extensions.rst
@@ -17,13 +17,13 @@
.. under the License.
..
-.. _reference:
+Extending Pinot
+===============
+This section provides an overview of options to extend Pinot code to make Pinot work for environments not covered by default.
.. toctree::
:maxdepth: 1
- pql_examples
- index_techniques
- client_api
- management_api
- pinot_hadoop
+ pluggable_streams
+ segment_fetcher
+ pluggable_storage
\ No newline at end of file
diff --git a/docs/reference.rst b/docs/getting_involved.rst
similarity index 89%
copy from docs/reference.rst
copy to docs/getting_involved.rst
index bb6891f..11a0d33 100644
--- a/docs/reference.rst
+++ b/docs/getting_involved.rst
@@ -17,13 +17,5 @@
.. under the License.
..
-.. _reference:
-
.. toctree::
:maxdepth: 1
-
- pql_examples
- index_techniques
- client_api
- management_api
- pinot_hadoop
diff --git a/docs/trying_pinot.rst b/docs/getting_started.rst
similarity index 99%
rename from docs/trying_pinot.rst
rename to docs/getting_started.rst
index 6fdc0e3..1621b79 100644
--- a/docs/trying_pinot.rst
+++ b/docs/getting_started.rst
@@ -17,8 +17,8 @@
.. under the License.
..
-Quick Demo
-==========
+Getting Started
+===============
A quick way to get familiar with Pinot is to run the Pinot examples. The examples can be run either by compiling the
code or by running the prepackaged Docker images.
diff --git a/docs/index.rst b/docs/index.rst
index aa6830d..6e809f1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -32,30 +32,35 @@ Introduction
intro
architecture
- trying_pinot
+ getting_started
#########
-Reference
+User Guide
#########
.. toctree::
:maxdepth: 1
+ user_guide
- reference
- in_production
+
+#########
+Admin Guide
+#########
+
+.. toctree::
+ :maxdepth: 1
+
+ admin_guide
#################
-Customizing Pinot
+Developer Guide
#################
.. toctree::
:maxdepth: 1
-
- pluggable_streams
- segment_fetcher
- pluggable_storage
+ dev_guide
################
Getting Involved
@@ -64,4 +69,4 @@ Getting Involved
.. toctree::
:maxdepth: 1
- coding_guidelines
+ getting_involved
\ No newline at end of file
diff --git a/docs/index_techniques.rst b/docs/index_techniques.rst
index 99451aa..51f0d1a 100644
--- a/docs/index_techniques.rst
+++ b/docs/index_techniques.rst
@@ -19,6 +19,7 @@
.. TODO: add more details
+
Index Techniques
================
diff --git a/docs/reference.rst b/docs/tuning_pinot.rst
similarity index 86%
copy from docs/reference.rst
copy to docs/tuning_pinot.rst
index bb6891f..a695fc9 100644
--- a/docs/reference.rst
+++ b/docs/tuning_pinot.rst
@@ -17,13 +17,11 @@
.. under the License.
..
-.. _reference:
+Tuning Pinot
+============
+This section provides information on various options to tune Pinot cluster for storage and query efficiency.
.. toctree::
:maxdepth: 1
- pql_examples
index_techniques
- client_api
- management_api
- pinot_hadoop
diff --git a/docs/reference.rst b/docs/user_guide.rst
similarity index 92%
rename from docs/reference.rst
rename to docs/user_guide.rst
index bb6891f..49babcc 100644
--- a/docs/reference.rst
+++ b/docs/user_guide.rst
@@ -17,13 +17,9 @@
.. under the License.
..
-.. _reference:
-
.. toctree::
:maxdepth: 1
pql_examples
- index_techniques
client_api
- management_api
- pinot_hadoop
+
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org