Răsfoiți Sursa

Rewrite contributing/index, rename pages, update references

Nathan Lovato 4 ani în urmă
părinte
comite
87a87205fb

+ 1 - 1
README.md

@@ -23,7 +23,7 @@ To get started, head to the [Contributing section](https://docs.godotengine.org/
 
 
 Here are some quick links to the areas you might be interested in:
 Here are some quick links to the areas you might be interested in:
 
 
-1. [Contributing to the online manual](https://docs.godotengine.org/en/latest/community/contributing/documentation_guidelines.html)
+1. [Contributing to the online manual](https://docs.godotengine.org/en/latest/community/contributing/contibuting_to_the_documentation.html)
 2. [Contributing to the class reference](https://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html)
 2. [Contributing to the class reference](https://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html)
 3. [Content guidelines](https://docs.godotengine.org/en/latest/community/contributing/content_guidelines.html)
 3. [Content guidelines](https://docs.godotengine.org/en/latest/community/contributing/content_guidelines.html)
 4. [Writing guidelines](https://docs.godotengine.org/en/latest/community/contributing/docs_writing_guidelines.html)
 4. [Writing guidelines](https://docs.godotengine.org/en/latest/community/contributing/docs_writing_guidelines.html)

+ 1 - 1
community/contributing/class_reference_writing_guidelines.rst

@@ -10,7 +10,7 @@ built-in node types.
 .. seealso::
 .. seealso::
 
 
     To learn to submit your changes to the Godot project using the Git version
     To learn to submit your changes to the Godot project using the Git version
-    control system, see :ref:`doc_updating_the_class_reference`.
+    control system, see :ref:`doc_updating_the_class_reference_with_git`.
 
 
 The reference for each class is contained in an XML file like the one below:
 The reference for each class is contained in an XML file like the one below:
 
 

+ 2 - 2
community/contributing/documentation_guidelines.rst → community/contributing/contributing_to_the_documentation.rst

@@ -1,4 +1,4 @@
-.. _doc_documentation_guidelines:
+.. _doc_contributing_to_the_documentation:
 
 
 Contributing to the documentation
 Contributing to the documentation
 =================================
 =================================
@@ -29,7 +29,7 @@ request triggers a rebuild of the online documentation upon merging.
              the :ref:`Godot API <toc-class-ref>` section of this documentation
              the :ref:`Godot API <toc-class-ref>` section of this documentation
              from them. If you want to update the description of a class, its
              from them. If you want to update the description of a class, its
              methods, or properties, read
              methods, or properties, read
-             :ref:`doc_updating_the_class_reference`.
+             :ref:`doc_updating_the_class_reference_with_git`.
 
 
 What is the Godot documentation
 What is the Godot documentation
 -------------------------------
 -------------------------------

+ 67 - 7
community/contributing/index.rst

@@ -1,25 +1,36 @@
 Contributing
 Contributing
 ============
 ============
 
 
-Everyone is most welcome to contribute to Godot. Here are some ways in which you can contribute to the project:
+Everyone is most welcome to contribute to Godot. Here are some ways in which you
+can contribute to the project:
 
 
 - Improving the engine by fixing bugs, coding new features, or refining existing ones.
 - Improving the engine by fixing bugs, coding new features, or refining existing ones.
-- Writing or proofreading documentation. You can contribute both to this reference manual or the code reference.
+- Writing or proofreading documentation. You can contribute both to this
+  reference manual or the code reference.
 - Translating the editor or documentation from English to other languages.
 - Translating the editor or documentation from English to other languages.
-- Reporting issues or `writing detailed proposals <https://github.com/godotengine/godot-proposals/>`__.
+- Reporting issues or `writing detailed proposals
+  <https://github.com/godotengine/godot-proposals/>`__.
 
 
 Getting started
 Getting started
 ---------------
 ---------------
 
 
+You would like to contribute but you don't know how or what to do? You can get
+answers below.
+
 .. toctree::
 .. toctree::
    :maxdepth: 1
    :maxdepth: 1
-   :name: toc-community-contributing
+   :name: toc-community-getting-started
 
 
    ways_to_contribute
    ways_to_contribute
 
 
+.. _doc_community_contributing_to_the_engine:
+
 Contributing to the engine
 Contributing to the engine
 --------------------------
 --------------------------
 
 
+The guides below explain how to contribute to the engine's core. You will learn
+about the code style, the contribution workflow, and more.
+
 .. toctree::
 .. toctree::
    :maxdepth: 1
    :maxdepth: 1
    :name: toc-community-contributing-to-the-engine
    :name: toc-community-contributing-to-the-engine
@@ -30,17 +41,66 @@ Contributing to the engine
    code_style_guidelines
    code_style_guidelines
    bug_triage_guidelines
    bug_triage_guidelines
 
 
+.. _doc_community_writing_documentation:
+
 Writing documentation
 Writing documentation
 ---------------------
 ---------------------
 
 
+We always need help to improve the documentation, be it the class reference or
+the manual. Below, you can find our content and writing guidelines and
+concrete guides to make changes to the documentation.
+
+Guidelines
+~~~~~~~~~~
+
+Here are the principles and guidelines we strive to follow to write accessible
+documentation.
+
 .. toctree::
 .. toctree::
    :maxdepth: 1
    :maxdepth: 1
-   :name: toc-community-contributing-to-documentation
+   :name: toc-community-writing-guidelines
 
 
-   documentation_guidelines
    content_guidelines
    content_guidelines
    docs_writing_guidelines
    docs_writing_guidelines
+
+Writing the manual
+~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-community-documentation
+
+   contributing_to_the_documentation
+   building_the_manual
+
+Class reference guides
+~~~~~~~~~~~~~~~~~~~~~~
+
+The pages below focus on the class reference.
+
+As the reference is included in the Godot editor, its source files are part of
+the `godot repository <https://github.com/godotengine/godot>`_. We use XML files
+to write it, so the process to contribute to the class reference differs from
+writing the online manual.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-community-class-reference
+
    updating_the_class_reference
    updating_the_class_reference
    class_reference_writing_guidelines
    class_reference_writing_guidelines
+
+.. _doc_community_translating_the_documentation:
+
+Translating the documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The community is always working hard on making Godot and its documentation
+available to more people. Localizing the documentation is a colossal and ongoing
+effort you can be part of.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-community-localization
+
    editor_and_docs_localization
    editor_and_docs_localization
-   building_the_manual

+ 1 - 1
community/contributing/updating_the_class_reference.rst

@@ -1,4 +1,4 @@
-.. _doc_updating_the_class_reference:
+.. _doc_updating_the_class_reference_with_git:
 
 
 Contributing to the class reference with Git
 Contributing to the class reference with Git
 ============================================
 ============================================

+ 2 - 2
community/contributing/ways_to_contribute.rst

@@ -181,7 +181,7 @@ There are two separate resources referred to as "documentation" in Godot:
    offline, directly in Godot's code editor, or online at :ref:`Godot API
    offline, directly in Godot's code editor, or online at :ref:`Godot API
    <toc-class-ref>`. To contribute to the class reference, you have to edit the
    <toc-class-ref>`. To contribute to the class reference, you have to edit the
    `doc/base/classes.xml` in Godot's Git repository, and make a pull request.
    `doc/base/classes.xml` in Godot's Git repository, and make a pull request.
-   See :ref:`doc_updating_the_class_reference` and
+   See :ref:`doc_updating_the_class_reference_with_git` and
    :ref:`doc_class_reference_writing_guidelines` for more details.
    :ref:`doc_class_reference_writing_guidelines` for more details.
 
 
 -  **The tutorials and engine documentation and its translations.** This is the part you are reading
 -  **The tutorials and engine documentation and its translations.** This is the part you are reading
@@ -189,7 +189,7 @@ There are two separate resources referred to as "documentation" in Godot:
    are generated from plain text files in the reStructured Text (rst) format,
    are generated from plain text files in the reStructured Text (rst) format,
    to which you can contribute via pull requests on the
    to which you can contribute via pull requests on the
    `godot-docs <https://github.com/godotengine/godot-docs>`_ GitHub repository.
    `godot-docs <https://github.com/godotengine/godot-docs>`_ GitHub repository.
-   See :ref:`doc_documentation_guidelines` for more details.
+   See :ref:`doc_contributing_to_the_documentation` for more details.
 
 
 Contributing translations
 Contributing translations
 -------------------------
 -------------------------