Skip to content

Commit 0cb7391

Browse files
committed
Migrate contributing contents to a separate documentation site.
1 parent 6de6560 commit 0cb7391

File tree

304 files changed

+879
-6588
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

304 files changed

+879
-6588
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ repos:
66
rev: v2.3.0
77
hooks:
88
- id: codespell
9-
files: ^(about|community|contributing|getting_started|tutorials)/.*\.rst$
9+
files: ^(about|community|engine_details|getting_started|tutorials)/.*\.rst$
1010
additional_dependencies: [tomli]
1111

1212
- repo: https://github.com/pre-commit/pre-commit-hooks

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Here are some quick links to the areas you might be interested in:
4242
3. [Content guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/content_guidelines.html)
4343
4. [Writing guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/docs_writing_guidelines.html)
4444
5. [Building the manual](https://docs.godotengine.org/en/latest/contributing/documentation/building_the_manual.html)
45-
6. [Translating the documentation](https://docs.godotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html)
45+
6. [Translating the documentation](https://contributing.godotengine.org/en/latest/documentation/translation/index.html)
4646

4747
## License
4848

_styleguides/de.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Lesbarkeit, Klarheit und Benutzbarkeit besonders im Vordergrund stehen.
88

99
Für die Übersetzung selbst ist das Tool
1010
[Weblate](https://hosted.weblate.org/projects/godot-engine/) im Einsatz, das in der
11-
[offiziellen Dokumentation](https://docs.godotengine.org/de/4.x/contributing/documentation/editor_and_docs_localization.html) näher
11+
[offiziellen Dokumentation](https://contributing.godotengine.org/en/latest/documentation/translation/index.html) näher
1212
erläutert wird. Die Bedienung von Weblate ist nicht Bestandteil dieses
1313
Dokuments.
1414

@@ -357,8 +357,8 @@ mit übersetzt werden sollten.
357357

358358
Für Übersetzungen des Editors und der Properties ist es ratsam, diese
359359
auch selbst zu testen, indem
360-
man [die aktuelle Übersetzung herunterlädt](https://docs.godotengine.org/de/4.x/contributing/documentation/editor_and_docs_localization.html#offline-translation-and-testing)
361-
und Godot mit den Änderungen [selbst kompiliert](https://docs.godotengine.org/de/4.x/contributing/development/compiling/compiling_for_windows.html).
360+
man [die aktuelle Übersetzung herunterlädt](https://contributing.godotengine.org/en/latest/documentation/translation/index.html#offline-translation-and-testing)
361+
und Godot mit den Änderungen [selbst kompiliert](https://docs.godotengine.org/de/4.x/engine_details/development/compiling/compiling_for_windows.html).
362362

363363
Gerade bei der Anleitung kommt es oft auf den Kontext zwischen benachbarten
364364
Textblöcken an, sodass das Lesen eines ganzen Artikels Fehler sichtbar

_templates/breadcrumbs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
}
3333
}
3434
</style>
35-
<a class="godot-edit-guidelines" href="https://docs.godotengine.org/en/latest/contributing/documentation/index.html#writing-documentation">
35+
<a class="godot-edit-guidelines" href="https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html">
3636
Learn how to contribute!
3737
</a>
3838
</li>

_tools/redirects/redirects.csv

Lines changed: 45 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -2,84 +2,60 @@ source,destination
22
/about/index.html,/index.html
33
/about/troubleshooting.html,/tutorials/troubleshooting.html
44
/classes/_classes.html,/classes/
5-
/community/contributing/best_practices_for_engine_contributors.html,/contributing/development/best_practices_for_engine_contributors.html
6-
/community/contributing/bisecting_regressions.html,/contributing/workflow/bisecting_regressions.html
7-
/community/contributing/bug_triage_guidelines.html,/contributing/workflow/bug_triage_guidelines.html
8-
/community/contributing/building_the_manual.html,/contributing/documentation/building_the_manual.html
9-
/community/contributing/class_reference_writing_guidelines.html,/contributing/documentation/class_reference_primer.html
10-
/community/contributing/code_style_guidelines.html,/contributing/development/code_style_guidelines.html
11-
/community/contributing/content_guidelines.html,/contributing/documentation/content_guidelines.html
12-
/community/contributing/contributing_to_the_documentation.html,/contributing/documentation/contributing_to_the_documentation.html
13-
/community/contributing/cpp_usage_guidelines.html,/contributing/development/cpp_usage_guidelines.html
14-
/community/contributing/docs_writing_guidelines.html,/contributing/documentation/docs_writing_guidelines.html
15-
/community/contributing/editor_and_docs_localization.html,/contributing/documentation/editor_and_docs_localization.html
16-
/community/contributing/index.html,/contributing/ways_to_contribute.html
17-
/community/contributing/pr_workflow.html,/contributing/workflow/pr_workflow.html
18-
/community/contributing/testing_pull_requests.html,/contributing/workflow/testing_pull_requests.html
19-
/community/contributing/updating_the_class_reference.html,/contributing/documentation/updating_the_class_reference.html
20-
/community/contributing/ways_to_contribute.html,/contributing/ways_to_contribute.html
215
/community/tutorials/3d/mesh_generation_with_heightmap_and_shaders.html,/tutorials/3d/mesh_generation_with_heightmap_and_shaders.html
226
/community/tutorials/gdnative/gdnative-c-example.html,/tutorials/plugins/gdnative/gdnative-c-example.html
237
/community/tutorials/gdnative/index.html,/tutorials/plugins/gdnative/index.html
248
/community/tutorials/vr/index.html,/tutorials/vr/index.html
259
/community/tutorials/vr/vr_primer.html,/tutorials/vr/vr_primer.html
2610
/content/3d/making_trees.html,/tutorials/content/making_trees.html
2711
/contributing/_contributing.html,/community/contributing/
28-
/contributing/bug_triage_guidelines.html,/community/contributing/bug_triage_guidelines.html
29-
/contributing/development/compiling/compiling_with_mono.html,/contributing/development/compiling/compiling_with_dotnet.html
30-
/contributing/development/core_and_modules/introduction_to_godot_development.html,/contributing/development/core_and_modules/index.html
31-
/contributing/doc_and_l10n_guidelines.html,/community/contributing/doc_and_l10n_guidelines.html
32-
/contributing/updating_the_class_reference.html,/community/contributing/updating_the_class_reference.html
33-
/contributing/ways_to_contribute.html,/contributing/how_to_contribute.html
34-
/development/compiling/compiling_for_android.html,/contributing/development/compiling/compiling_for_android.html
35-
/development/compiling/compiling_for_ios.html,/contributing/development/compiling/compiling_for_ios.html
36-
/development/compiling/compiling_for_linuxbsd.html,/contributing/development/compiling/compiling_for_linuxbsd.html
37-
/development/compiling/compiling_for_macos.html,/contributing/development/compiling/compiling_for_macos.html
38-
/development/compiling/compiling_for_uwp.html,/contributing/development/compiling/compiling_for_uwp.html
39-
/development/compiling/compiling_for_web.html,/contributing/development/compiling/compiling_for_web.html
40-
/development/compiling/compiling_for_windows.html,/contributing/development/compiling/compiling_for_windows.html
41-
/development/compiling/compiling_for_x11.html,/contributing/development/compiling/compiling_for_linuxbsd.html
42-
/development/compiling/compiling_with_mono.html,/contributing/development/compiling/compiling_with_mono.html
43-
/development/compiling/compiling_with_script_encryption_key.html,/contributing/development/compiling/compiling_with_script_encryption_key.html
44-
/development/compiling/cross-compiling_for_ios_on_linux.html,/contributing/development/compiling/cross-compiling_for_ios_on_linux.html
45-
/development/compiling/getting_source.html,/contributing/development/compiling/getting_source.html
46-
/development/compiling/index.html,/contributing/development/compiling/index.html
47-
/development/compiling/introduction_to_the_buildsystem.html,/contributing/development/compiling/introduction_to_the_buildsystem.html
48-
/development/compiling/optimizing_for_size.html,/contributing/development/compiling/optimizing_for_size.html
12+
/contributing/development/compiling/compiling_with_mono.html,/engine_details/development/compiling/compiling_with_dotnet.html
13+
/contributing/development/core_and_modules/introduction_to_godot_development.html,/engine_details/development/core_and_modules/index.html
14+
/development/compiling/compiling_for_android.html,/engine_details/development/compiling/compiling_for_android.html
15+
/development/compiling/compiling_for_ios.html,/engine_details/development/compiling/compiling_for_ios.html
16+
/development/compiling/compiling_for_linuxbsd.html,/engine_details/development/compiling/compiling_for_linuxbsd.html
17+
/development/compiling/compiling_for_macos.html,/engine_details/development/compiling/compiling_for_macos.html
18+
/development/compiling/compiling_for_uwp.html,/engine_details/development/compiling/compiling_for_uwp.html
19+
/development/compiling/compiling_for_web.html,/engine_details/development/compiling/compiling_for_web.html
20+
/development/compiling/compiling_for_windows.html,/engine_details/development/compiling/compiling_for_windows.html
21+
/development/compiling/compiling_for_x11.html,/engine_details/development/compiling/compiling_for_linuxbsd.html
22+
/development/compiling/compiling_with_mono.html,/engine_details/development/compiling/compiling_with_mono.html
23+
/development/compiling/compiling_with_script_encryption_key.html,/engine_details/development/compiling/compiling_with_script_encryption_key.html
24+
/development/compiling/cross-compiling_for_ios_on_linux.html,/engine_details/development/compiling/cross-compiling_for_ios_on_linux.html
25+
/development/compiling/getting_source.html,/engine_details/development/compiling/getting_source.html
26+
/development/compiling/index.html,/engine_details/development/compiling/index.html
27+
/development/compiling/introduction_to_the_buildsystem.html,/engine_details/development/compiling/introduction_to_the_buildsystem.html
28+
/development/compiling/optimizing_for_size.html,/engine_details/development/compiling/optimizing_for_size.html
4929
/development/consoles/consoles.html,/tutorials/platform/consoles.html
50-
/development/cpp/binding_to_external_libraries.html,/contributing/development/core_and_modules/binding_to_external_libraries.html
51-
/development/cpp/common_engine_methods_and_macros.html,/contributing/development/core_and_modules/common_engine_methods_and_macros.html
52-
/development/cpp/configuring_an_ide/android_studio.html,/contributing/development/configuring_an_ide/android_studio.html
53-
/development/cpp/configuring_an_ide/clion.html,/contributing/development/configuring_an_ide/clion.html
54-
/development/cpp/configuring_an_ide/code_blocks.html,/contributing/development/configuring_an_ide/code_blocks.html
55-
/development/cpp/configuring_an_ide/index.html,/contributing/development/configuring_an_ide/index.html
56-
/development/cpp/configuring_an_ide/kdevelop.html,/contributing/development/configuring_an_ide/kdevelop.html
57-
/development/cpp/configuring_an_ide/qt_creator.html,/contributing/development/configuring_an_ide/qt_creator.html
58-
/development/cpp/configuring_an_ide/visual_studio.html,/contributing/development/configuring_an_ide/visual_studio.html
59-
/development/cpp/configuring_an_ide/visual_studio_code.html,/contributing/development/configuring_an_ide/visual_studio_code.html
60-
/development/cpp/configuring_an_ide/xcode.html,/contributing/development/configuring_an_ide/xcode.html
61-
/development/cpp/core_types.html,/contributing/development/core_and_modules/core_types.html
62-
/development/cpp/custom_audiostreams.html,/contributing/development/core_and_modules/custom_audiostreams.html
63-
/development/cpp/custom_godot_servers.html,/contributing/development/core_and_modules/custom_godot_servers.html
64-
/development/cpp/custom_modules_in_cpp.html,/contributing/development/core_and_modules/custom_modules_in_cpp.html
30+
/development/cpp/binding_to_external_libraries.html,/engine_details/development/core_and_modules/binding_to_external_libraries.html
31+
/development/cpp/common_engine_methods_and_macros.html,/engine_details/development/core_and_modules/common_engine_methods_and_macros.html
32+
/development/cpp/configuring_an_ide/android_studio.html,/engine_details/development/configuring_an_ide/android_studio.html
33+
/development/cpp/configuring_an_ide/clion.html,/engine_details/development/configuring_an_ide/clion.html
34+
/development/cpp/configuring_an_ide/code_blocks.html,/engine_details/development/configuring_an_ide/code_blocks.html
35+
/development/cpp/configuring_an_ide/index.html,/engine_details/development/configuring_an_ide/index.html
36+
/development/cpp/configuring_an_ide/kdevelop.html,/engine_details/development/configuring_an_ide/kdevelop.html
37+
/development/cpp/configuring_an_ide/qt_creator.html,/engine_details/development/configuring_an_ide/qt_creator.html
38+
/development/cpp/configuring_an_ide/visual_studio.html,/engine_details/development/configuring_an_ide/visual_studio.html
39+
/development/cpp/configuring_an_ide/visual_studio_code.html,/engine_details/development/configuring_an_ide/visual_studio_code.html
40+
/development/cpp/configuring_an_ide/xcode.html,/engine_details/development/configuring_an_ide/xcode.html
41+
/development/cpp/core_types.html,/engine_details/development/core_and_modules/core_types.html
42+
/development/cpp/custom_audiostreams.html,/engine_details/development/core_and_modules/custom_audiostreams.html
43+
/development/cpp/custom_godot_servers.html,/engine_details/development/core_and_modules/custom_godot_servers.html
44+
/development/cpp/custom_modules_in_cpp.html,/engine_details/development/core_and_modules/custom_modules_in_cpp.html
6545
/development/cpp/custom_resource_format_loaders.html,/contributing/development/core_and_modules/custom_resource_format_loaders.html
66-
/development/cpp/index.html,/contributing/development/core_and_modules/index.html
67-
/development/cpp/inheritance_class_tree.html,/contributing/development/core_and_modules/inheritance_class_tree.html
68-
/development/cpp/introduction_to_godot_development.html,/contributing/development/core_and_modules/introduction_to_godot_development.html
69-
/development/cpp/macos_debug.html,/contributing/development/debugging/macos_debug.html
70-
/development/cpp/object_class.html,/contributing/development/core_and_modules/object_class.html
71-
/development/cpp/unit_testing.html,/contributing/development/core_and_modules/unit_testing.html
72-
/development/cpp/using_cpp_profilers.html,/contributing/development/debugging/using_cpp_profilers.html
73-
/development/cpp/variant_class.html,/contributing/development/core_and_modules/variant_class.html
74-
/development/cpp/vulkan/index.html,/contributing/development/debugging/vulkan/index.html
75-
/development/cpp/vulkan/vulkan_validation_layers.html,/contributing/development/debugging/vulkan/vulkan_validation_layers.html
76-
/development/editor/creating_icons.html,/contributing/development/editor/creating_icons.html
77-
/development/editor/editor_style_guide.html,/contributing/development/editor/editor_style_guide.html
78-
/development/editor/index.html,/contributing/development/editor/index.html
79-
/development/editor/introduction_to_editor_development.html,/contributing/development/editor/introduction_to_editor_development.html
80-
/development/file_formats/gdscript_grammar.html,/contributing/development/file_formats/gdscript_grammar.html
81-
/development/file_formats/index.html,/contributing/development/file_formats/index.html
82-
/development/file_formats/tscn.html,/contributing/development/file_formats/tscn.html
46+
/development/cpp/index.html,/engine_details/development/core_and_modules/index.html
47+
/development/cpp/inheritance_class_tree.html,/engine_details/development/core_and_modules/inheritance_class_tree.html
48+
/development/cpp/introduction_to_godot_development.html,/engine_details/development/core_and_modules/introduction_to_godot_development.html
49+
/development/cpp/macos_debug.html,/engine_details/development/debugging/macos_debug.html
50+
/development/cpp/object_class.html,/engine_details/development/core_and_modules/object_class.html
51+
/development/cpp/unit_testing.html,/engine_details/development/core_and_modules/unit_testing.html
52+
/development/cpp/using_cpp_profilers.html,/engine_details/development/debugging/using_cpp_profilers.html
53+
/development/cpp/variant_class.html,/engine_details/development/core_and_modules/variant_class.html
54+
/development/cpp/vulkan/index.html,/engine_details/development/debugging/vulkan/index.html
55+
/development/cpp/vulkan/vulkan_validation_layers.html,/engine_details/development/debugging/vulkan/vulkan_validation_layers.html
56+
/development/file_formats/gdscript_grammar.html,/engine_details/development/file_formats/gdscript_grammar.html
57+
/development/file_formats/index.html,/engine_details/development/file_formats/index.html
58+
/development/file_formats/tscn.html,/engine_details/development/file_formats/tscn.html
8359
/development/plugins/import_plugins.html,/tutorials/plugins/editor/import_plugins.html
8460
/development/plugins/index.html,/tutorials/plugins/editor/index.html
8561
/development/plugins/making_plugins.html,/tutorials/plugins/editor/making_plugins.html

about/complying_with_licenses.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ with the original one.
2727

2828
This section covers compliance with licenses from a user perspective.
2929
If you are interested in licence compliance as a contributor, you can find
30-
guidelines :ref:`here <doc_best_practices_for_engine_contributors_license_compliance>`.
30+
guidelines `here <https://contributing.godotengine.org/en/latest/engine/guidelines/best_practices.html#don-t-use-complex-canned-solutions-for-simple-problems>`__.
3131

3232
.. tip::
3333

about/docs_changelog.rst

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ Contributing
7878
~~~~~~~~~~~~
7979

8080
- :ref:`doc_handling_compatibility_breakages`
81-
- :ref:`doc_ways_to_contribute`
8281

8382
GDExtension
8483
~~~~~~~~~~~
@@ -215,11 +214,6 @@ Shaders
215214

216215
- :ref:`doc_compute_shaders`
217216

218-
Workflow
219-
~~~~~~~~
220-
221-
- :ref:`doc_pr_review_guidelines`
222-
223217
XR
224218
~~
225219

@@ -253,11 +247,6 @@ Editor
253247
New pages since version 3.3
254248
---------------------------
255249

256-
C++
257-
~~~
258-
259-
- :ref:`doc_cpp_usage_guidelines`
260-
261250
GDScript
262251
~~~~~~~~
263252

@@ -283,19 +272,10 @@ Best practices
283272

284273
- :ref:`doc_version_control_systems`
285274

286-
Community
287-
~~~~~~~~~
288-
289-
- :ref:`doc_best_practices_for_engine_contributors`
290-
- :ref:`doc_bisecting_regressions`
291-
- :ref:`doc_editor_and_docs_localization`
292-
293275
Development
294276
~~~~~~~~~~~
295277

296-
- :ref:`doc_introduction_to_editor_development`
297-
- :ref:`doc_editor_style_guide`
298-
- :ref:`doc_common_engine_methods_and_macros`
278+
- :ref:`doc_common_engine_methods_and_macros_error_macros`
299279
- :ref:`doc_vulkan_validation_layers`
300280
- :ref:`doc_gdscript_grammar`
301281
- Configuring an IDE: :ref:`doc_configuring_an_ide_code_blocks`

about/faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ compile the engine from sources, or how to build the documentation. You also nee
448448
get familiar with Git, a version control system that Godot developers use.
449449

450450
We explain how to work with the engine source, how to edit the documentation, and
451-
what other ways to contribute are there in our :ref:`documentation for contributors <doc_ways_to_contribute>`.
451+
what other ways to contribute are there in our `documentation for contributors <https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html>`__.
452452

453453
I have a great idea for Godot. How can I share it?
454454
--------------------------------------------------
@@ -629,7 +629,7 @@ for the rest of the game.
629629
How can I support Godot development or contribute?
630630
--------------------------------------------------
631631

632-
See :ref:`doc_ways_to_contribute`.
632+
See `How to contribute <https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html>`__.
633633

634634
Who is working on Godot? How can I contact you?
635635
-----------------------------------------------

about/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ About this documentation
100100
Members of the Godot Engine community continuously write, correct, edit, and
101101
improve this documentation. We are always looking for more help. You can also
102102
contribute by opening Github issues or translating the documentation into your language.
103-
If you are interested in helping, see :ref:`Ways to contribute <doc_ways_to_contribute>`
104-
and :ref:`Writing documentation <doc_contributing_writing_documentation>`,
103+
If you are interested in helping, see `How to contribute <https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html>`__
104+
and :ref:`Writing documentation <https://contributing.godotengine.org/en/latest/documentation/manual/index.html>`__,
105105
or get in touch with the `Documentation team <https://godotengine.org/teams/#documentation>`_
106106
on `Godot Contributors Chat <https://chat.godotengine.org/>`_.
107107

0 commit comments

Comments
 (0)