From 1d86648a7fc9ebac93eca29c6894c5f42fedb6ed Mon Sep 17 00:00:00 2001 From: bootjp / Yoshiaki Ueda Date: Sat, 19 Feb 2022 20:29:02 +0900 Subject: [PATCH] docs: fix typo GitHub is officially known as GitHub. https://github.com/logos Signed-off-by: bootjp / Yoshiaki Ueda --- .github/ISSUE_TEMPLATE.md | 4 ++-- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- CONTRIBUTING.md | 2 +- Documentation/development-flow.md | 4 ++-- Documentation/storage-providers.md | 4 ++-- GOVERNANCE.md | 2 +- INSTALL.md | 2 +- OWNERS.md | 6 +++--- README.md | 2 +- ROADMAP.md | 2 +- SECURITY.md | 2 +- build/release/README.md | 4 ++-- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 3125b2b96ae4..9328d27e25a6 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -24,8 +24,8 @@ * Crashing pod(s) logs, if necessary To get logs, use `kubectl -n logs ` -When pasting logs, always surround them with backticks or use the `insert code` button from the Github UI. -Read [Github documentation if you need help](https://help.github.com/en/articles/creating-and-highlighting-code-blocks). +When pasting logs, always surround them with backticks or use the `insert code` button from the GitHub UI. +Read [GitHub documentation if you need help](https://help.github.com/en/articles/creating-and-highlighting-code-blocks). **Feature Request** diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c367c28eafec..932050141e87 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -26,7 +26,7 @@ labels: bug To get logs, use `kubectl -n logs ` When pasting logs, always surround them with backticks or use the `insert code` button from the Github UI. -Read [Github documentation if you need help](https://help.github.com/en/articles/creating-and-highlighting-code-blocks). +Read [GitHub documentation if you need help](https://help.github.com/en/articles/creating-and-highlighting-code-blocks). **Environment**: * OS (e.g. from /etc/os-release): diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9536153a90e5..22049f047364 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -174,6 +174,6 @@ We should explore this further with some experimentation and potentially leverag ### Alternatives Considered -The built in support in Github for [`CODEOWNERS`](https://help.github.com/en/articles/about-code-owners) files was considered. +The built in support in GitHub for [`CODEOWNERS`](https://help.github.com/en/articles/about-code-owners) files was considered. However, this only supports the automated assignment of reviewers to pull requests. It has no tiering or differentiation between roles like the proposed maintainers/reviewers model has and is therefore not a good fit. diff --git a/Documentation/development-flow.md b/Documentation/development-flow.md index 956d621ada4b..eb7ae12699f6 100644 --- a/Documentation/development-flow.md +++ b/Documentation/development-flow.md @@ -12,7 +12,7 @@ don't hesitate to reach out to us on our [Slack](https://Rook-io.slack.com) dev 1. [GO 1.13](https://golang.org/dl/) or greater installed 2. Git client installed -3. Github account +3. GitHub account ## Initial Setup @@ -276,7 +276,7 @@ If a feature it is a full description of the new functionality. * refer to the issue it's closing, this is mandatory when fixing a bug * have a sign-off, this is achieved by adding `-s` when committing so in practice run `git commit -s`. If not the DCO bot will complain. If you forgot to add the sign-off you can also amend a previous commit with the sign-off by running `git commit --amend -s`. -If you've pushed your changes to Github already you'll need to force push your branch with `git push -f`. +If you've pushed your changes to GitHub already you'll need to force push your branch with `git push -f`. Here is an example of an acceptable commit message: diff --git a/Documentation/storage-providers.md b/Documentation/storage-providers.md index 560f41278232..052a15f19fd8 100644 --- a/Documentation/storage-providers.md +++ b/Documentation/storage-providers.md @@ -47,7 +47,7 @@ Rook provides the following framework to assist storage providers in building an Operators in their own repo define their own cadence and versioning scheme as desired. * Storage providers own their release process, while following Rook best practices to ensure high quality. - * Each provider owns independent CI based on Github actions, with patterns and build + * Each provider owns independent CI based on GitHub actions, with patterns and build automation that can be re-used by providers * Docker images are pushed to the [Rook DockerHub](https://hub.docker.com/u/rook) where each storage provider has its own repo. @@ -79,7 +79,7 @@ The engineering costs of each storage provider include: * Rook maintainers will help answer questions along the way, but ultimately you own the development * If there are test failures in the CI, they should be investigated in a timely manner -* If issues are opened in Github, they need investigation and triage to provide +* If issues are opened in GitHub, they need investigation and triage to provide expectations about the priority and timeline * If users have questions in Slack, they should be answered in a timely manner. Community members can also be redirected to other locations if desired for the provider. diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 9797dac11b82..91e7cd108c4e 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -106,7 +106,7 @@ should volunteer to be moved to emeritus status. In extreme cases this can also the maintainers per the voting process below. -### Github Project Administration +### GitHub Project Administration Maintainers will be added to the Rook GitHub organization (if they are not already) and added to the GitHub Maintainers team. diff --git a/INSTALL.md b/INSTALL.md index 8a1270d17d0d..d58c8a89db26 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -42,7 +42,7 @@ Run `make help` for more options. ## CI Workflow -Every PR and every merge to master triggers the CI process in Github actions. +Every PR and every merge to master triggers the CI process in GitHub actions. On every commit to PR and master the CI will build, run unit tests, and run integration tests. If the build is for master or a release, the build will also be published to [dockerhub.com](https://cloud.docker.com/u/rook/repository/list). diff --git a/OWNERS.md b/OWNERS.md index 3099d1ba85b9..127ffb4a1b00 100644 --- a/OWNERS.md +++ b/OWNERS.md @@ -9,8 +9,8 @@ This page lists all active contributors and their areas of expertise. This can b Steering committee members will be added according to the [process for adding a steering committee member](GOVERNANCE.md#becoming-a-steering-committee-member) in the [governance](GOVERNANCE.md). -| Name | Represents | Github | -| ------------------------------------ | ----------- | ------------------------------------- | +| Name | Represents | GitHub | +| ------------------------------------ | ----------- |---------------------------------------| | Travis Nielsen | Ceph | [travisn](https://github.com/travisn) | | Jared Watts | Independent | [jbw976](https://github.com/jbw976) | @@ -47,5 +47,5 @@ Code owners, as described in the [change approval process](GOVERNANCE.md#change- ## Community We are grateful for the countless members of the community who contribute to Rook, -whether reporting issues in Github or Slack or submitting code or documentation PRs. +whether reporting issues in GitHub or Slack or submitting code or documentation PRs. Thank you for helping this project to grow and mature! diff --git a/README.md b/README.md index bfdf6298f8f0..bf2df1db1626 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ For further details, please see the complete [security release process](SECURITY Please use the following to reach members of the community: - Slack: Join our [slack channel](https://slack.rook.io) -- Github: Start a [discussion](https://github.com/rook/rook/discussions) or open an [issue](https://github.com/rook/rook/issues) +- GitHub: Start a [discussion](https://github.com/rook/rook/discussions) or open an [issue](https://github.com/rook/rook/issues) - Twitter: [@rook_io](https://twitter.com/rook_io) - Security topics: [cncf-rook-security@lists.cncf.io](#reporting-security-vulnerabilities) diff --git a/ROADMAP.md b/ROADMAP.md index 3c5a0733c331..ff8a8056357d 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -6,7 +6,7 @@ Community and contributor involvement is vital for successfully implementing all We hope that the items listed below will inspire further engagement from the community to keep Rook progressing and shipping exciting and valuable features. Any dates listed below and the specific issues that will ship in a given milestone are subject to change but should give a general idea of what we are planning. -See the [Github project boards](https://github.com/rook/rook/projects) for the most up-to-date issues and their status. +See the [GitHub project boards](https://github.com/rook/rook/projects) for the most up-to-date issues and their status. ## Rook Ceph 1.9 diff --git a/SECURITY.md b/SECURITY.md index 6bbe7872471f..8a47a360b408 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -42,7 +42,7 @@ beta or stable storage provider **MUST** have a representative on the PST. ### Private Disclosure Processes If you find a security vulnerability or any security related issues, please **DO NOT** file a public -issue. **Do not** create a Github issue. Instead, send your report privately to +issue. **Do not** create a GitHub issue. Instead, send your report privately to [cncf-rook-security@lists.cncf.io](mailto:cncf-rook-security@lists.cncf.io). Security reports are greatly appreciated and we will publicly thank you for it. diff --git a/build/release/README.md b/build/release/README.md index 5604d74bdfe4..1c289e10cb9b 100644 --- a/build/release/README.md +++ b/build/release/README.md @@ -8,7 +8,7 @@ The workflow at a high level for minor releases is as follows: 2. Create the new release branch with a beta release when the commits are winding down 3. When all the release criteria is met we tag the final release -Github actions provide all the jobs to complete the release -- there is no need to perform any of the release tasks on a build/dev machine. +GitHub actions provide all the jobs to complete the release -- there is no need to perform any of the release tasks on a build/dev machine. ## Minor Release Criteria @@ -53,7 +53,7 @@ in the next section with the updated version. **IMPORTANT** Before tagging the release, open a new PR to update the documentation and example manifest tags to the release version. -To publish a new release build, run the `Tag` action in Github actions. Be sure to use the correct branch for the +To publish a new release build, run the `Tag` action in GitHub actions. Be sure to use the correct branch for the release. New minor releases will always be run from master, and patch releases will come from a previously created release branch.