DOCS-#2426,DOCS-#2424: Fixed two issues

- Closes #2424, CONTRIBUTING.rst does not render the commit message formatting example - Closes #2426, Bad links in index.rst - Renamed CONTRIBUTING.rst into contributing.rst Signed-off-by: Victor Fomin <vfdev.5@gmail.com>
modin-project · Nov 14, 2020 · 2449add · 2449add
1 parent 5252282
commit 2449add
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 13 deletions.
diff --git a/docs/CONTRIBUTING.rst → docs/contributing.rst b/docs/CONTRIBUTING.rst → docs/contributing.rst
@@ -49,7 +49,6 @@ with this project or the open source license(s) involved."
    Signed-off-by: Awesome Developer <developer@example.org>
 
 
-.
 Code without a proper signoff cannot be merged into the
 master branch. Note: You must use your real name (sorry, no pseudonyms or anonymous
 contributions.)
@@ -88,7 +87,9 @@ To ensure that all commit messages in the master branch follow a specific format
 enforce that all commit messages must follow the following format:
 
 .. code-block:: bash
-  FEAT-#9999: Add `DataFrame.rolling` functionality, to enable rolling window operations
+
+    FEAT-#9999: Add `DataFrame.rolling` functionality, to enable rolling window operations
+
 The ``FEAT`` component represents the type of commit. This component of the commit
 message can be one of the following:
 

diff --git a/docs/developer/architecture.rst b/docs/developer/architecture.rst
@@ -234,7 +234,7 @@ Supported Execution Frameworks and Memory Formats
 
 This is the list of execution frameworks and memory formats supported in Modin. If you
 would like to contribute a new execution framework or memory format, please see the
-documentation page on :doc:`../CONTRIBUTING`.
+documentation page on :doc:`../contributing`.
 
 - `Pandas on Ray`_
     - Uses the Ray_ execution framework.

diff --git a/docs/index.rst b/docs/index.rst
@@ -136,10 +136,10 @@ nature, you get a fast DataFrame at 1MB and 1TB+.
 .. toctree::
    :caption: How is Modin different from ...?
 
-    comparisons/index
-    comparisons/pandas
-    comparisons/dask
-    comparisons/spark
+   comparisons/index
+   comparisons/pandas
+   comparisons/dask
+   comparisons/spark
 
 .. toctree::
    :caption: Supported APIs
@@ -164,12 +164,6 @@ nature, you get a fast DataFrame at 1MB and 1TB+.
    UsingPyarrowonRay/index
    UsingSQLonRay/index
 
-.. toctree::
-   :caption: Contributing to Modin
-
-   contributing
-   architecture
-
 .. toctree::
    :caption: Help