This is an automated email from the ASF dual-hosted git repository. sunithabeeram pushed a commit to branch docs in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git
commit 068fc52e2ccae84f4abef9b617bc234c867f1015 Author: Sunitha Beeram <sbee...@linkedin.com> AuthorDate: Wed Mar 6 21:55:17 2019 -0800 Fix formatting issues and figures used --- docs/README.md | 43 ++++++++++++++++++++++++------------------- docs/dev_env.rst | 15 ++++++++++----- docs/img/PinotBroker.png | Bin 31737 -> 40314 bytes docs/img/PinotController.png | Bin 43621 -> 47991 bytes docs/img/PinotFoundation.png | Bin 35783 -> 44122 bytes docs/img/PinotServer.png | Bin 43540 -> 55062 bytes 6 files changed, 34 insertions(+), 24 deletions(-) diff --git a/docs/README.md b/docs/README.md index 0e41afc..5f23fcc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,23 +1,28 @@ -.. -.. Licensed to the Apache Software Foundation (ASF) under one -.. or more contributor license agreements. See the NOTICE file -.. distributed with this work for additional information -.. regarding copyright ownership. The ASF licenses this file -.. to you under the Apache License, Version 2.0 (the -.. "License"); you may not use this file except in compliance -.. with the License. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, -.. software distributed under the License is distributed on an -.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -.. KIND, either express or implied. See the License for the -.. specific language governing permissions and limitations -.. under the License. -.. +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> 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 +3. Open _build/html/index.html in your favorite browser and ensure contents and links work correctly. + +NOTE: +You may see some differences locally as the version of sphinx-build on your local host might not be the same as the one used in readthedocs.io for building the pinot website docs. \ No newline at end of file diff --git a/docs/dev_env.rst b/docs/dev_env.rst index d54bb45..dd8aee6 100644 --- a/docs/dev_env.rst +++ b/docs/dev_env.rst @@ -28,17 +28,21 @@ Dev Environment Setup To contribute to Pinot, please follow the instructions below. +Git +--- +Pinot uses git for source code management. If you are new to Git, it will be good to review `basics <https://git-scm.com/book/en/v1/Getting-Started-Git-Basics>`_ of Git and a common tasks like `managing branches <https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell>`_ and `rebasing <https://git-scm.com/book/en/v2/Git-Branching-Rebasing>`_. + Getting the Source Code ----------------------- - Create a fork ^^^^^^^^^^^^^ -To limit the number of branches created on the main Pinot repository, we recommend that you create a fork by clicking on the fork button `here <https://github.com/apache/incubator-pinot>`_. - -.. code-block:: none +To limit the number of branches created on the Apache Pinot repository, we recommend that you create a fork by clicking on the fork button `here <https://github.com/apache/incubator-pinot>`_. Clone the repository locally ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + $mkdir workspace $cd workspace $git clone https://github.com/<username>/incubator-pinot.git @@ -47,9 +51,10 @@ Clone the repository locally Maven ----- Pinot is a Maven project and familiarity with Maven will help you work with Pinot code. If you are new to Maven, you can -more `here <maven.apache.org>`_ and `here <http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html>`_. +read about Maven `here <maven.apache.org>`_ and `get a quick overview here <http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html>`_. Run the following maven command to setup the project. + .. code-block:: none # compile, download sources diff --git a/docs/img/PinotBroker.png b/docs/img/PinotBroker.png index 675834d..f14badd 100644 Binary files a/docs/img/PinotBroker.png and b/docs/img/PinotBroker.png differ diff --git a/docs/img/PinotController.png b/docs/img/PinotController.png index 451e20b..63a658b 100644 Binary files a/docs/img/PinotController.png and b/docs/img/PinotController.png differ diff --git a/docs/img/PinotFoundation.png b/docs/img/PinotFoundation.png index 889f2fc..91a85a4 100644 Binary files a/docs/img/PinotFoundation.png and b/docs/img/PinotFoundation.png differ diff --git a/docs/img/PinotServer.png b/docs/img/PinotServer.png index f2789bc..38ac17e 100644 Binary files a/docs/img/PinotServer.png and b/docs/img/PinotServer.png differ --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org