Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Rewrite the step_by_step series #4325

Merged
merged 8 commits into from
Dec 2, 2020
Merged

Rewrite the step_by_step series #4325

merged 8 commits into from
Dec 2, 2020

Conversation

NathanLovato
Copy link
Contributor

@NathanLovato NathanLovato commented Oct 29, 2020 •
edited

See #4302 first, which is the PR for the introduction section. This second builds upon it so #4302 should get reviewed and merged first.

Closes #2459
Closes #1664
Closes #1663
Closes #1510
Closes #1001

@NathanLovato NathanLovato added the content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features label Oct 29, 2020
@NathanLovato NathanLovato marked this pull request as draft October 29, 2020 20:18
@NathanLovato
Copy link
Contributor Author

The first part, nodes_and_scenes.rst, is ready to review.

@NathanLovato NathanLovato force-pushed the content/getting_started_2.0 branch 4 times, most recently from 68bb690 to f1eb377 Compare November 2, 2020 14:42
@NathanLovato
Copy link
Contributor Author

The instancing page is ready to review

@NathanLovato NathanLovato force-pushed the content/getting_started_2.0 branch 3 times, most recently from 1ef68f4 to 2cf7eb1 Compare November 5, 2020 13:59
@NathanLovato
Copy link
Contributor Author

The scripting languages page is ready to review.

@NathanLovato NathanLovato force-pushed the content/getting_started_2.0 branch 3 times, most recently from f8fe03b to 72cbef9 Compare November 6, 2020 04:06
@NathanLovato
Copy link
Contributor Author

NathanLovato commented Nov 6, 2020 •
edited

Added the hands on scripting tut. It's lacking images but it's late here so I'm about to tap out.

I'd like to get a read and people to tell me if the amount of detail is fine, that is, neither too little nor too much for a broad audience like people who read the Godot docs.

Thinking about accessibility, I ended up putting quite a lot of details and notes despite the code's simplicity in the hope to better explain how game code and a gdscript file work.

Note: while the final page will provide C# code tabs, the focus is still on GDScript. There's no way around focusing on one language and its specifics in these kinds of tutorials. To offer the same experience to people learning with or C# or even visual script, I think we'd need separate pages so the text or media can explain the specificities of each language.

The docs:

  1. Creating your first script: https://github.com/godotengine/godot-docs/blob/72cbef9b7c441567e20c03454c289b5ada180faf/getting_started/step_by_step/scripting_first_script.rst
  2. Listening to player input: https://github.com/godotengine/godot-docs/blob/72cbef9b7c441567e20c03454c289b5ada180faf/getting_started/step_by_step/scripting_player_input.rst

@NathanLovato NathanLovato force-pushed the content/getting_started_2.0 branch 3 times, most recently from b952392 to 404d146 Compare November 6, 2020 20:59
@NathanLovato
Copy link
Contributor Author

Just added images and polished the scripting part. I'm going to edit and clean-up some old content as a bonus and then the last page left for this PR is the signals intro.

@NathanLovato
Copy link
Contributor Author

NathanLovato commented Nov 6, 2020 •
edited

@akien-mga for this PR and its parent PR #4302, what do you think of merging them to get user reviews? It's hard for the target audience to come and review the series on GitHub. Once merged, I could share the series with the community, in particular, new Godot users so they can go through it and report any issues or questions they have.

Saying that because I tried sharing the PR and some documents and got feedback from few users, although it's positive so far.

@NathanLovato NathanLovato force-pushed the content/getting_started_2.0 branch 2 times, most recently from e3f149f to f03eefa Compare November 7, 2020 23:03
@NathanLovato
Copy link
Contributor Author

Okay the content's kinda there. Ready to review.

@NathanLovato NathanLovato marked this pull request as ready for review November 7, 2020 23:03
@NathanLovato
Copy link
Contributor Author

Added two pictures and minor edit, now it's done done!

@NathanLovato
Copy link
Contributor Author

NB: I'll move remaining content that shouldn't be in the series in other PRs, like #4344

YuriSizov
YuriSizov reviewed Nov 8, 2020
View reviewed changes
getting_started/introduction/introduction_to_godot.rst Outdated
.. note:: The Godot team can't provide an open-source console export due to the
licensing terms imposed by console manufacturers. Regardless of the
engine you use, though, releasing games on consoles is always a lot of
work. You can read more on that here:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing link 🙃

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you review the intro in its PR? It's #4302. This PR is just based on it because there are links to the intro, but 4302 should be reviewed and merged first.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, this is confusing...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the first message to reflect that. I just split the work into two PRs hoping the other would get reviews and merged while this one was a draft.

YuriSizov
YuriSizov reviewed Nov 8, 2020
View reviewed changes
getting_started/introduction/introduction_to_godot.rst Outdated
.. image:: img/introduction_helms_of_fury.jpg

As for applications, the open-source pixel art drawing program Pixelorama is
powered by Godot, and so is the voxel RPG creator RPG in a box.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should product names be formatted with italic maybe? RPG in a box looks especially blended into the sentence.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same remark, this is the intro, see #4302. Note I'm taking note of these comments.

@NathanLovato
Copy link
Contributor Author

Thanks for taking the time to review!

@YuriSizov YuriSizov mentioned this pull request Nov 22, 2020
Closed
@NathanLovato NathanLovato mentioned this pull request Nov 25, 2020
Merged
@akien-mga
Copy link
Member

@akien-mga for this PR and its parent PR #4302, what do you think of merging them to get user reviews? It's hard for the target audience to come and review the series on GitHub. Once merged, I could share the series with the community, in particular, new Godot users so they can go through it and report any issues or questions they have.

Agreed, I'm sorry I've been the bottleneck for so long here.

Needs a rebase now that #4302 is merged, then we can merge.

@NathanLovato NathanLovato force-pushed the content/getting_started_2.0 branch 2 times, most recently from 620c5a9 to de33fa3 Compare December 2, 2020 21:40
@NathanLovato
Write intro_to_the_editor_interface.rst
eeb58b8 
Closes godotengine#4167
@NathanLovato
Write nodes and scenes
f958094 
Closes godotengine#4170
@NathanLovato
Re-write instancing.rst
d6cc561 
This is a complete rewrite and merge of instancing.rst and
instancing_continued.rst. The goal was to simplify the language and
unify the tutorial around the falling ball. Some instructions are more
detailed than in the original article.

There are also more pictures, all new, and using yellow outlines for
color-blind people.

Closes godotengine#4175
Closes godotengine#4171
@NathanLovato
Remove unused pictures
e7643e5
@NathanLovato
Rewrite and rename scripting -> scripting_languages
fbb8105 
The page now focuses on giving an overview of official scripting languages.
Removed first example using signals. We'll introduce signals later in
the series.

Moved the explanation of what scripts are and do to the top, before
talking about languages.

Mentioned other things like that GDScript isn't like Python, that it's
an imperative and OO language, with links to wikipedia that explain the
jargon.

Closes godotengine#4172
@NathanLovato
Write first script and player input pages
f68abde 
Closes godotengine#4173
@NathanLovato
Rewrite step_by_step/signals.rst
1d2ff09 
Closes godotengine#4174
@NathanLovato
Remove scripting_continued.rst
15b02ec
@NathanLovato NathanLovato merged commit 96637f2 into godotengine:master Dec 2, 2020
@NathanLovato NathanLovato deleted the content/getting_started_2.0 branch December 2, 2020 21:54
@YuriSizov YuriSizov mentioned this pull request Nov 1, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@YuriSizov YuriSizov YuriSizov left review comments

Assignees
No one assigned
Labels
content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features
Projects
None yet
Milestone
No milestone
3 participants
@NathanLovato @akien-mga @YuriSizov