Skip to content

Commit 5a5bae8

Browse files
authored
Update Documents to Improve Consistency (apache#47341)
* Update "Report Bugs" section to use "GitHub Issues" for consistency * Fix typos in documentation regarding GitHub references * Update "Github" to "GitHub" for consistency
1 parent 3a87490 commit 5a5bae8

12 files changed

+16
-16
lines changed

COMMITTERS.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ To be able to merge PRs, committers have to integrate their GitHub ID with Apach
212212

213213
1. Verify you have a GitHub ID `enabled with 2FA <https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/>`__.
214214
2. Merge your Apache and GitHub accounts using `GitBox (Apache Account Linking utility) <https://gitbox.apache.org/setup/>`__. This also asks you to link your
215-
Github id to your Apache account. You should see 5 green checks in GitBox.
215+
GitHub ID to your Apache account. You should see 5 green checks in GitBox.
216216
3. Wait at least 30 minutes for an email inviting you to Apache GitHub Organization and accept invitation.
217217
4. After accepting the GitHub Invitation verify that you are a member of the `Airflow committers team on GitHub <https://github.com/orgs/apache/teams/airflow-committers>`__.
218218
5. Ask in ``#internal-airflow-ci-cd`` channel to be `configured in self-hosted runners <https://github.com/apache/airflow-ci-infra/blob/main/scripts/list_committers>`_
@@ -221,7 +221,7 @@ To be able to merge PRs, committers have to integrate their GitHub ID with Apach
221221

222222
* ``dev/breeze/src/airflow_breeze/global_constants.py`` (COMMITTERS variable)
223223
* name and GitHub ID in `project.rst <https://github.com/apache/airflow/blob/main/docs/apache-airflow/project.rst>`__.
224-
* If you had been a collaborator role before getting committer, remove your Github ID from ``.asf.yaml``.
224+
* If you had been a collaborator role before getting committer, remove your GitHub ID from ``.asf.yaml``.
225225
7. Raise a PR to `airflow-site <https://github.com/apache/airflow-site>`_ repository with the following additions:
226226

227227
* List your name(s) in the `committers list <https://github.com/apache/airflow-site/blob/main/landing-pages/site/data/committers.json>`__.

ISSUE_TRIAGE_PROCESS.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ There are several actions an issue triager might take:
129129
Labels
130130
''''''
131131

132-
Since Apache Airflow uses "GitHub Issues" and "Github Discussions" as the
132+
Since Apache Airflow uses "GitHub Issues" and "GitHub Discussions" as the
133133
issue tracking systems, the use of labels is extensive. Though issue
134134
labels tend to change over time based on components within the project,
135135
the majority of the ones listed below should stand the test of time.
@@ -256,7 +256,7 @@ once the issue is accepted (and assigned with relevant kind and area labels). Th
256256
ask for other members of the community for consultation or ask for further information from the issue author.
257257
Removing the ``needs-triage`` label means that the issue has been accepted and awaits implementation (no further triage action required),
258258
as long as the ``needs-triage`` label remains the triage team will keep an eye on the issue and check periodically
259-
if it needs to be accepted or closed/converted to Github Discussion.
259+
if it needs to be accepted or closed/converted to GitHub Discussion.
260260
``needs-triage`` label may also be applied manually by committers if they think a further action from the triage team is required.
261261

262262
**area Label**

contributing-docs/01_roles_in_airflow_project.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ code is maintained.
4545
The term "committer" and "maintainer" is used interchangeably. The term "committer" is the official term used by the
4646
Apache Software Foundation, while "maintainer" is more commonly used in the Open Source community and is used
4747
in context of GitHub in a number of guidelines and documentation, so this document will mostly use "maintainer",
48-
when speaking about Github, Pull Request, Github Issues and Discussions. On the other hand, "committer" is more
48+
when speaking about GitHub, Pull Request, GitHub Issues and Discussions. On the other hand, "committer" is more
4949
often used in devlist discussions, official communications, Airflow website and every time when we formally
5050
refer to the role.
5151

contributing-docs/04_how_to_contribute.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ some of those ways that involve creating issues and pull requests on GitHub.
2626
Report Bugs
2727
-----------
2828

29-
Report bugs through `GitHub <https://github.com/apache/airflow/issues>`__.
29+
Report bugs through `GitHub Issues <https://github.com/apache/airflow/issues>`__.
3030

3131
Please report relevant information and preferably code that exhibits the problem.
3232

dev/breeze/doc/09_release_management_tasks.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Adding git tags for providers
193193
"""""""""""""""""""""""""""""
194194

195195
This command can be utilized to manage git tags for providers within the airflow remote repository during provider releases.
196-
Sometimes in cases when there is a connectivity issue to Github, it might be possible that local tags get created and lead to annoying errors.
196+
Sometimes in cases when there is a connectivity issue to GitHub, it might be possible that local tags get created and lead to annoying errors.
197197
The default behaviour would be to clean such local tags up.
198198

199199
The flag ``--clean-local-tags`` can be used to delete the local tags.

dev/breeze/doc/adr/0013-get-rid-of-submodules.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ by definitions should be easy to do, otherwise they are not getting done regular
6666
## Decision
6767

6868
The decision is to use the approach suggested by
69-
[Github Actions Security Hardening](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)
69+
[GitHub Actions Security Hardening](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)
7070
by simply pinning the potentially insecure GitHub Actions via full-length SHA of the commit
7171

7272
The point 2) about submodules should take the following form
7373

74-
2) For security reason for non-GitHub owned actions (which are heavily protected asset of Github Actions
74+
2) For security reason for non-GitHub owned actions (which are heavily protected asset of GitHub Actions
7575
and compromising them would mean compromising the whole GitHub Actions infrastructure) we use full-length
7676
SHA of the action to refer to the action code. We do it after careful review of the action code - with the
7777
comment explaining version of the action the SHA refers to. When we upgrade the action we update the SHA

dev/breeze/doc/ci/01_ci_environment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ To run the tests, we need to ensure that the images are built using the
6262
latest sources and that the build process is efficient. A full rebuild
6363
of such an image from scratch might take approximately 15 minutes.
6464
Therefore, we've implemented optimization techniques that efficiently
65-
use the cache from Github Actions Artifacts.
65+
use the cache from GitHub Actions Artifacts.
6666

6767
## GitHub Registry used as cache
6868

dev/breeze/doc/ci/02_images.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -572,4 +572,4 @@ percent-encoded when you access them via UI (/ = %2F)
572572

573573
----
574574

575-
Read next about [Github Variables](03_github_variables.md)
575+
Read next about [GitHub Variables](03_github_variables.md)

dev/breeze/doc/ci/03_github_variables.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Example command to build your CI image efficiently in your own CI
6363
workflow:
6464

6565
``` bash
66-
# GITHUB_REPOSITORY is set automatically in Github Actions so we need to override it with flag
66+
# GITHUB_REPOSITORY is set automatically in GitHub Actions so we need to override it with flag
6767
#
6868
breeze ci-image build --github-repository apache/airflow --python 3.10
6969
docker tag ghcr.io/apache/airflow/main/ci/python3.10 your-image-name:tag

dev/breeze/doc/ci/04_selective_checks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ providers.
163163
The selective check outputs available are described below. In case of `list-as-string` values,
164164
empty string means `everything`, where lack of the output means `nothing` and list elements are
165165
separated by spaces. This is to accommodate for the wau how outputs of this kind can be easily used by
166-
Github Actions to pass the list of parameters to a command to execute
166+
GitHub Actions to pass the list of parameters to a command to execute
167167

168168

169169
| Output | Meaning of the output | Example value | List |

dev/breeze/doc/ci/06_debugging.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2222
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
2323

24-
- [Debugging CI Jobs in Github Actions and changing their behaviour](#debugging-ci-jobs-in-github-actions-and-changing-their-behaviour)
24+
- [Debugging CI Jobs in GitHub Actions and changing their behaviour](#debugging-ci-jobs-in-github-actions-and-changing-their-behaviour)
2525

2626
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2727

28-
# Debugging CI Jobs in Github Actions and changing their behaviour
28+
# Debugging CI Jobs in GitHub Actions and changing their behaviour
2929

3030
The CI jobs are notoriously difficult to test, because you can only
3131
really see results of it when you run them in CI environment, and the

docs/README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ When you make changes to the docs, it follows roughly the same process as creati
4141
1. **Decide to edit in GitHub UI or locally** - Depending on the size and type of docs update you want to make, it might be easier to work in the UI or to make your edits in a local fork.
4242
2. **Find the source files to edit** - While you can access most of the docs source files using the **Suggest a change on this page** button or by searching for a string in the ``/docs/`` file directory, in some cases, the source strings might be located in different provider docs or in the source code itself.
4343
3. **If editing locally, run spellcheck and the build to identify any blocking errors** - Docs require build, spellcheck, and precommit CI/CD tests to pass before they can merge. This means that if you have a pull request with docs changes, a docs build error can prevent your code merge. Checking the build and spelling locally first can help speed up reviews. If you made formatting changes, checking a local build of your docs allows you to make sure you correctly formatted elements like tables, text styling, and line breaks.
44-
4. **Make your pull request** - When you make a PR, Github automatically assigns reviewers and runs CI/CD tests.
44+
4. **Make your pull request** - When you make a PR, GitHub automatically assigns reviewers and runs CI/CD tests.
4545
5. **Fix any build errors or spelling mistakes** - Your PR can't be merged if there are any spelling or build errors. Check to see which builds are failing and click **Show details**. The output of the tests share the errors, location of the problems, and suggest resolutions. Common Docs failures occur due to incorrect formatting and whitespace.
4646

4747
Editing in GitHub or locally

0 commit comments

Comments
 (0)