-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Migrate contributing contents to a separate documentation site. #11188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate contributing contents to a separate documentation site. #11188
Conversation
4236dad
to
e644aca
Compare
Everything removed here makes sense to me, will check the other repo as well |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Ivorforce This needs a rebase and update now to replace the URL with https://contributing.godotengine.org
I rebased onto latest ![]() All of them should be trivially resolvabe because the pages stay on this repo, they were just moved. |
e644aca
to
4d932a0
Compare
564e967
to
561563a
Compare
Ok, I managed to fix all the compile problems on this PR. Some changes of note:
Note that the new docs still need to be finalized for this PR to be mergable. |
cc @AThousandShips @skyace65 A final review pass would be welcome if anyone wants to |
Will look this over sometime this weekend |
I'll take a look next week |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I built this branch and didn't get any errors so this looks good to me. We need to remember to move over issues relating to the contributing section to the new repository when this is merged.
561563a
to
56580c3
Compare
classes/class_arraymesh.rst
Outdated
@@ -436,7 +436,7 @@ Sets a name for a given surface. | |||
|
|||
.. container:: contribute | |||
|
|||
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! | |||
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference/index.html>`__! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Has the same /index
oversight that the main repo had. I assume these will all be taken care of with a local rebuild based on the latest main repo PR changes?
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference/index.html>`__! | |
There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch!
I'm not 100% sure it will stay at class_reference.html
without an index.html
forever, but luckily with a new repo we have opportunity to add new redirects. So I'll just change it to what we have now (class_reference.html
), like in the main repo.
56580c3
to
0855668
Compare
Thanks @Repiteo for spotting that and the review in general :) Gonna go ahead and merge this in |
Important
We're discussing / working on moving the contributing information out of the engine documentation. If you want to discuss this change, please join the discussion on RocketChat. Please discuss only implementation details in this PR.
This PR is the tandem to the WIP repository for new contributions documentation.
Reasoning
Here's why we're considering making this change:
Structure
Contributing
is removed, but not everything in this section is relevant only to engine contributors. People making modules or GDExtensions also need to know about engine development, and this information correlates to specific engine versions. Therefore, significant chunks of theContributing
section should persist in this repository.The engine information however needs a new home. I'm suggesting new section
Engine details
. This currently houses the 3 subsections for Architecture / Code, Development / Buildsystem / Tooling, and File Formats.I think this new section will benefit the engine documentation, as it isn't buried so deep among contributing information. People looking to understand the source code without necessarily contributing should find this information much more easily.