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.

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

Merged
merged 5 commits into from
Sep 22, 2020
Merged

Docs: Update git workflow documentation #25164

merged 5 commits into from
Sep 22, 2020

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Sep 8, 2020

Description

  • 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

How has this been tested?

Documentation, confirm it all makes sense and works as expected.
View rendered on branch here.

Types of changes

Documentation.

@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Sep 8, 2020
@github-actions
Copy link

github-actions bot commented Sep 8, 2020

Size Change: -34.1 kB (2%)

Total Size: 1.17 MB

Filename Size Change
build/a11y/index.js 1.14 kB +2 B (0%)
build/annotations/index.js 3.52 kB -1 B
build/block-directory/index.js 8.53 kB +124 B (1%)
build/block-editor/index.js 128 kB -95 B (0%)
build/block-library/editor-rtl.css 8.56 kB -26 B (0%)
build/block-library/editor.css 8.56 kB -26 B (0%)
build/block-library/index.js 135 kB +80 B (0%)
build/block-serialization-default-parser/index.js 1.78 kB +2 B (0%)
build/blocks/index.js 47.5 kB -2 B (0%)
build/components/index.js 167 kB -34.5 kB (20%) 🎉
build/components/style.css 15.5 kB -2 B (0%)
build/compose/index.js 9.42 kB -3 B (0%)
build/core-data/index.js 12 kB -1 B
build/data/index.js 8.43 kB +1 B
build/date/index.js 31.9 kB -2 B (0%)
build/dom/index.js 4.42 kB -1 B
build/edit-navigation/index.js 10.4 kB +1 B
build/edit-post/index.js 306 kB +3 B (0%)
build/edit-post/style-rtl.css 6.24 kB +5 B (0%)
build/edit-post/style.css 6.23 kB +5 B (0%)
build/edit-site/index.js 19.7 kB +160 B (0%)
build/edit-site/style-rtl.css 3.3 kB +5 B (0%)
build/edit-site/style.css 3.3 kB +5 B (0%)
build/edit-widgets/index.js 17.5 kB -2 B (0%)
build/edit-widgets/style-rtl.css 2.8 kB +5 B (0%)
build/edit-widgets/style.css 2.8 kB +4 B (0%)
build/editor/index.js 45.5 kB +148 B (0%)
build/editor/style-rtl.css 3.8 kB +2 B (0%)
build/editor/style.css 3.8 kB +2 B (0%)
build/html-entities/index.js 621 B -1 B
build/i18n/index.js 3.55 kB +1 B
build/is-shallow-equal/index.js 709 B -2 B (0%)
build/list-reusable-blocks/index.js 3.02 kB +1 B
build/notices/index.js 1.69 kB -1 B
build/plugins/index.js 2.44 kB +2 B (0%)
build/server-side-render/index.js 2.61 kB +1 B
build/url/index.js 4.06 kB -1 B
build/viewport/index.js 1.74 kB -1 B
build/warning/index.js 1.13 kB +1 B
ℹ️ View Unchanged
Filename Size Change
build/api-fetch/index.js 3.34 kB 0 B
build/autop/index.js 2.72 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/style-rtl.css 11.1 kB 0 B
build/block-editor/style.css 11.1 kB 0 B
build/block-library/style-rtl.css 7.6 kB 0 B
build/block-library/style.css 7.59 kB 0 B
build/block-library/theme-rtl.css 741 B 0 B
build/block-library/theme.css 741 B 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/components/style-rtl.css 15.5 kB 0 B
build/data-controls/index.js 1.27 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/edit-navigation/style-rtl.css 868 B 0 B
build/edit-navigation/style.css 871 B 0 B
build/editor/editor-styles-rtl.css 492 B 0 B
build/editor/editor-styles.css 493 B 0 B
build/element/index.js 4.45 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.49 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 1.74 kB 0 B
build/keyboard-shortcuts/index.js 2.39 kB 0 B
build/keycodes/index.js 1.85 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.12 kB 0 B
build/nux/index.js 3.27 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/primitives/index.js 1.34 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13.7 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.24 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@paaljoachim
Copy link
Contributor

paaljoachim commented Sep 12, 2020

--- 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"
Thank you for adding the video walk through and the slides!

Git workflow.

In a more everyday language:
Copy (fork) the Github WP repo to your own Github account.
Copy (clone) your Github WP repo to your own local computer.
Not sure what to say what branching is again. Perhaps work in a specific area (branch).
Work on code/doc and confirm (commit).
Add (push) the local code/doc to your Github WP repo.
From your Github repo add (Pull Request) the code/doc to the WP repo.

@mkaz
Copy link
Member Author

mkaz commented Sep 18, 2020

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
Copy link
Member

@noahtallen noahtallen left a 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!

docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
docs/contributors/git-workflow.md Outdated Show resolved Hide resolved
Thanks! 👍

Co-authored-by: Noah Allen <noahtallen@gmail.com>
@mkaz mkaz merged commit a61eeb0 into master Sep 22, 2020
@mkaz mkaz deleted the update/docs-git-workflow branch September 22, 2020 22:52
@github-actions github-actions bot added this to the Gutenberg 9.1 milestone Sep 22, 2020
@paaljoachim
Copy link
Contributor

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.
Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants