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

Fix grammatical issues #9997

Merged
merged 17 commits into from Nov 29, 2022
Merged

Fix grammatical issues #9997

merged 17 commits into from Nov 29, 2022

Conversation

umarfchy
Copy link
Contributor

What I did

This PR fixes the grammatical errors in README.md, CONTRIBUTING.md, BUILDING.md, PULL_REQUEST_TEMPLATE.md, and some files in docs/reference/.

Related issue

(not mandatory) A picture of a cute animal, if possible in relation to what you did
cat with green eyes

@umarfchy
fix typo in README.md
9d5527d 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical errors in CONTRIBUTING.md
fe2c0e6 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical error in BUILDING.md
377e186 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical errors in compose_convert.md
ddf695e 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical error in compose_exec.md
709574a 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical error in compose_ls.md
a6af763 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical error in compose_ps.md
2158cec 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical error in compose.md
0d1984f 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
fix grammatical error in PULL_REQUEST_TEMPLATE.md
331f1ad 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy umarfchy marked this pull request as ready for review November 15, 2022 10:53
@umarfchy
Copy link
Contributor Author

Hi @glours, would you mind taking a look into the PR 🙂 ? As a first-time contributor, I need approval from one of the maintainers to run the GitHub actions workflow. As the changes are mainly related to various markdown files, I'm hoping that it won't break anything. Thanks.

@glours
Copy link
Contributor

glours commented Nov 15, 2022

@umarfchy thanks for your PR
As I'm not a native speaker, and surely introduced a bunch of those grammar mistakes, I would prefer that @milas or @nicksieger to review it 😅

@glours
Copy link
Contributor

glours commented Nov 16, 2022

The CI complains about doc generation issues, you should run this command make docs and commit the modified files

@umarfchy
generate docs
483d4d6 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy
Copy link
Contributor Author

umarfchy commented Nov 16, 2022 •
edited

Hi @glours, thanks for the instruction. I've generated the docs and made the commit as per the instruction. Guess, I'd require the GH workflow approval once again 😅.

One quick question, is the PR too big? Should I have broken this into multiple PRs? As for someone new to open source, I just wanted to make sure that I'm really living up to the spirit 🔥 of the project. Thanks and really appreciate the help 😊.

@umarfchy
Copy link
Contributor Author

Hi @milas, would you mind looking into the PR 🙂? Thanks.

milas
milas approved these changes Nov 21, 2022
View reviewed changes
Copy link
Member

@milas milas left a comment

Choose a reason for hiding this comment

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

Thanks for the cleanup. Paging @aevesdocker as well to take a quick pass.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/reference/compose.md Outdated Show resolved Hide resolved
docs/reference/compose.md Outdated Show resolved Hide resolved
docs/reference/compose_ls.md Outdated Show resolved Hide resolved
docs/reference/docker_compose.yaml Show resolved Hide resolved
docs/reference/docker_compose.yaml Outdated Show resolved Hide resolved
docs/reference/docker_compose.yaml Outdated Show resolved Hide resolved
docs/reference/docker_compose.yaml Outdated Show resolved Hide resolved
milas
milas requested changes Nov 21, 2022
View reviewed changes
Copy link
Member

@milas milas left a comment

Choose a reason for hiding this comment

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

(agh, meant to request changes on previous review - see suggestions on it)

@aevesdocker
Copy link
Contributor

aevesdocker commented Nov 22, 2022 •
edited

I agree with your corrections @milas, the rest looks good as well 👍 thank you @umarfchy

umarfchy and others added 6 commits November 27, 2022 22:46
@umarfchy @milas
add revisions with grammatical changes in compose_convert.md
a2d0d17 
Co-authored-by: Milas Bowman <milasb@gmail.com>
Signed-off-by: Umar Faruq Chowdhury <38253031+umarfchy@users.noreply.github.com>
@umarfchy @milas
add revisions with grammatical changes in compose_exec.md
85e171d 
Co-authored-by: Milas Bowman <milasb@gmail.com>
Signed-off-by: Umar Faruq Chowdhury <38253031+umarfchy@users.noreply.github.com>
@umarfchy @milas
add revisions with grammatical changes in compose_ls.md
1f4a165 
Co-authored-by: Milas Bowman <milasb@gmail.com>
Signed-off-by: Umar Faruq Chowdhury <38253031+umarfchy@users.noreply.github.com>
@umarfchy @milas
add revisions with grammatical changes in docker_compose.yaml
bdcb886 
Co-authored-by: Milas Bowman <milasb@gmail.com>
Signed-off-by: Umar Faruq Chowdhury <38253031+umarfchy@users.noreply.github.com>
@umarfchy @milas
add revisions with grammatical changes in compose.md
8762d19 
Co-authored-by: Milas Bowman <milasb@gmail.com>
Signed-off-by: Umar Faruq Chowdhury <38253031+umarfchy@users.noreply.github.com>
@umarfchy @milas
add revisions with grammatical changes in CONTRIBUTING.md
2062f10 
Co-authored-by: Milas Bowman <milasb@gmail.com>
Signed-off-by: Umar Faruq Chowdhury <38253031+umarfchy@users.noreply.github.com>
umarfchy
umarfchy commented Nov 27, 2022
View reviewed changes
Copy link
Contributor Author

@umarfchy umarfchy left a comment •
edited

Choose a reason for hiding this comment

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

Hi @milas, I've made changes accordingly. Thanks for taking the time to review the PR.

@umarfchy
generate docs
712cd0e 
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
@umarfchy umarfchy requested a review from milas November 27, 2022 17:34
@codecov-commenter
Copy link

Codecov Report

Base: 75.86% // Head: 74.56% // Decreases project coverage by -1.29% ⚠️

Coverage data is based on head (712cd0e) compared to base (34e945a).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff             @@
##               v2    #9997      +/-   ##
==========================================
- Coverage   75.86%   74.56%   -1.30%     
==========================================
  Files           2        2              
  Lines         232      232              
==========================================
- Hits          176      173       -3     
- Misses         49       51       +2     
- Partials        7        8       +1
Impacted Files Coverage Δ
pkg/e2e/framework.go 72.55% <0.00%> (-1.40%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@milas milas merged commit 06e7137 into docker:v2 Nov 29, 2022
@milas milas self-assigned this Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@milas milas milas approved these changes

Assignees

@milas milas

Labels
kind/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@umarfchy @glours @aevesdocker @codecov-commenter @milas