-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Docs: Update git workflow documentation #25164
Conversation
Size Change: -34.1 kB (2%) Total Size: 1.17 MB
ℹ️ View Unchanged
|
--- Following comment will be edited, as I add additional information. ---- Hey Marcus I am going through the documentation now. (I plan on not clicking on any external doc links as I need to know that the doc in itself works.) Thank you for starting with the Git Workflow section. It gives me that chance to find out more about how to use Git. -- The initial read through of the Overview which is nice to have is that gush this is a lot of steps (here I say on an early Saturday morning not fully awake yet...) Fork (copy) the Gutenberg repository. -- Git Workflow Walkthrough This is an important reminder: "The workflow for code and documentation is the same—since both are managed in GitHub" Git workflow. In a more everyday language: |
Thanks for the comments, and the review. With regards to the overview at top, I don't want to change the language because it should match the steps you are supposed to do. Also, as you can see there is confusion when using the same word "copy" for both fork and clone. The in-depth portion covers the details for each step, and the diagram shows the progression. |
- Update with links to hallway hangout video and slides - Add new section for more detailed instructions including screenshots - Expand page descrition with additional links for git and PRs - Minor editing for clarification
f769959
to
5a1c8f4
Compare
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 added a lot of non-blocking grammatical comments, but this is great!
Thanks! 👍 Co-authored-by: Noah Allen <noahtallen@gmail.com>
Hey Marcus. Can you please update the link to the docs that is now merged? So that I can throughly go through it next week. |
Description
How has this been tested?
Documentation, confirm it all makes sense and works as expected.
View rendered on branch here.
Types of changes
Documentation.