Skip to content

Commit eb0db1d

Browse files
authored
Revert "Repo sync"
1 parent ae57a16 commit eb0db1d

File tree

10 files changed

+58
-96
lines changed

10 files changed

+58
-96
lines changed

.github/CONTRIBUTING.md

Lines changed: 37 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -2,113 +2,86 @@
22

33
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:.
44

5-
**📖 For comprehensive contribution guidance, please visit our official documentation at [docs.github.com/en/contributing](https://docs.github.com/en/contributing). This is our canonical source for all contribution processes and policies.**
6-
75
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
86

9-
This guide provides repository-specific information to supplement the official contribution documentation. For detailed processes, policies, and best practices, always refer to [docs.github.com/en/contributing](https://docs.github.com/en/contributing).
7+
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
108

11-
Use the table of contents icon <img alt="Table of contents icon" src="/contributing/images/table-of-contents.png" width="25" height="25" /> in the top corner of this document to get to a specific section of this guide quickly.
9+
Use the table of contents icon <img alt="Table of contents icon" src="/contributing/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
1210

1311
## New contributor guide
1412

15-
**Start here:** Visit [docs.github.com/en/contributing](https://docs.github.com/en/contributing) for complete contributor onboarding and guidelines.
16-
17-
For repository-specific setup, read the [README](../README.md) file. The official docs site also provides these helpful resources:
13+
To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions:
1814

1915
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
2016
- [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)
2117
- [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
2218
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
2319

24-
## Contribution types and what we're looking for
25-
26-
Content we accept:
27-
* Technical and grammatical corrections
28-
* Typo fixes
29-
* Expanded explanations of existing products or features, when the expansion has a compelling reason
30-
* New content filling important gaps in our documentation. For example, [this pull request](https://github.com/github/docs/pull/38048) added a useful section on security hardening for GitHub Actions.
3120

32-
Content we do not currently accept:
33-
* Edits purely for tone, readability, or efficiency
34-
* Topics that are too niche or a matter of personal preference
35-
* Changes to the underlying site and workflows
21+
## Getting started
3622

37-
These are general guidelines, but if you’re not sure what category your proposed change would fall under, feel free to open an issue to discuss it with us!
23+
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)."
3824

39-
## Getting started
25+
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
4026

41-
📚 **Primary resource:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing) contains our complete contribution workflow and policies.
27+
### Issues
4228

43-
For repository-specific information:
44-
- See [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:
45-
- Check our [types of contributions](/contributing/types-of-contributions.md) we accept
46-
- Review our markdown style guidelines in the `/contributing` directory
29+
#### Create a new issue
4730

48-
### Writing style guidelines
31+
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
4932

50-
When contributing content, please follow these key principles from our [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide):
33+
#### Solve an issue
5134

52-
- **Clarity and simplicity**: The goal of our writing style is clarity and simplicity.
53-
- **Meaning over grammar**: Grammatical correctness is important, but not as important as clarity and meaning.
54-
- **Second person**: The docs use second-person ("you") to communicate directly with readers.
55-
- **Inclusive language**: Use inclusive language by not assuming gender or ability level, and by avoiding slang and idioms.
56-
- **Accessible technical language**: Jargon is sometimes necessary, but don't assume every reader has your technical expertise.
57-
- **Active voice**: Use active voice wherever possible. Active voice means avoiding "be" verbs like "is" or "are" when you can, but also choosing more dynamic verbs to get your point across. "Press (a key)" is less dynamic than "tap (a key)," for example.
58-
- **Clear terminology**: Avoid technical abbreviations like "repo" and "PR," and Latin abbreviations like "i.e." and "e.g."
35+
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
5936

60-
For complete style guidance, see our [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide).
37+
### Make Changes
6138

62-
### Issues
39+
#### Make changes in the UI
6340

64-
**For detailed issue guidelines, see [docs.github.com/en/contributing](https://docs.github.com/en/contributing).**
41+
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
6542

66-
#### Repository-specific notes:
67-
- Search [existing issues](https://github.com/github/docs/issues) before creating new ones
68-
- Use our [label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference) to categorize appropriately
69-
- Follow the issue templates provided in this repository
43+
<img src="/contributing/images/contribution_cta.png" />
7044

71-
### Make Changes
45+
#### Make changes in a codespace
7246

73-
**Complete change guidelines are available at [docs.github.com/en/contributing](https://docs.github.com/en/contributing).**
47+
For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)."
7448

75-
#### Repository-specific options:
49+
#### Make changes locally
7650

77-
**Make changes in the UI:** Click **Make a contribution** at the bottom of any docs page for small changes like typos or broken links.
51+
1. Fork the repository.
52+
- Using GitHub Desktop:
53+
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
54+
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
7855

79-
<img src="/contributing/images/contribution_cta.png" />
56+
- Using the command line:
57+
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
8058

81-
**Make changes in a codespace:** See "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)" for documentation-specific setup.
59+
2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](../contributing/development.md).
8260

83-
**Make changes locally:**
84-
1. Fork the repository (see [official forking guide](https://docs.github.com/en/contributing))
85-
2. Install Node.js at the version specified in `.node-version` (see [development guide](../contributing/development.md))
86-
3. Create a working branch and start with your changes
61+
3. Create a working branch and start with your changes!
8762

8863
### Commit your update
8964

90-
Follow the guidelines at [docs.github.com/en/contributing](https://docs.github.com/en/contributing) for commit best practices.
91-
92-
Use our "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" before committing.
65+
Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" to speed up the review process :zap:.
9366

9467
### Pull Request
9568

96-
**Complete pull request (PR) guidelines:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing)
97-
98-
**Repository-specific notes:**
99-
- Fill the "Ready for review" template
100-
- [Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if applicable
101-
- Enable [maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
102-
103-
A Docs team member will review following our [standard review process](https://docs.github.com/en/contributing).
69+
When you're finished with the changes, create a pull request, also known as a PR.
70+
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
71+
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
72+
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
73+
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
74+
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
75+
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
76+
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
10477

10578
### Your PR is merged!
10679

10780
Congratulations :tada::tada: The GitHub team thanks you :sparkles:.
10881

109-
Once merged, your contributions will be visible on [GitHub docs](https://docs.github.com/en).
82+
Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en).
11083

111-
Continue contributing using our [types of contributions guide](/contributing/types-of-contributions.md) or explore more opportunities at [docs.github.com/en/contributing](https://docs.github.com/en/contributing).
84+
Now that you are part of the GitHub docs community, see how else you can [contribute to the docs](/contributing/types-of-contributions.md).
11285

11386
## Windows
11487

content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/managing-policies-for-code-governance.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,6 @@ You can edit a ruleset to change parts of the ruleset, such as the name, bypass
4444
1. In the left sidebar, in the "Policies" section, click **Code**, then click **Rulesets**.
4545
1. To the right of the ruleset's name, select {% octicon "kebab-horizontal" aria-label="Open additional options" %}, then click **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete ruleset**.
4646

47-
{% ifversion repo-rules-history %}
48-
4947
## Using ruleset history
5048

5149
{% data reusables.repositories.ruleset-beta-note %}
@@ -57,10 +55,6 @@ You can edit a ruleset to change parts of the ruleset, such as the name, bypass
5755
1. To view the history of changes to the ruleset, select {% octicon "kebab-horizontal" aria-label="Open additional options" %} to the right of the ruleset's name, then click **{% octicon "history" aria-hidden="true" aria-label="history" %} History**.
5856
1. To the right of the specific iteration, select {% octicon "kebab-horizontal" aria-label="Open additional options" %}, then click **Compare changes**, **Restore**, or **Download**.
5957

60-
{% endif %}
61-
62-
{% ifversion repo-rules-management %}
63-
6458
## Importing a ruleset
6559

6660
You can import a ruleset from another repository, organization or enterprise using the exported JSON file from the previous section. This can be useful if you want to apply the same ruleset to multiple repositories, organizations or enterprises.
@@ -71,8 +65,6 @@ You can import a ruleset from another repository, organization or enterprise usi
7165
1. Open the exported JSON file.
7266
1. Review the imported ruleset and click **Create**.
7367

74-
{% endif %}
75-
7668
## Viewing insights for rulesets
7769

7870
You can view insights for rulesets to see how rulesets are affecting the repositories in your enterprise. {% data reusables.repositories.about-ruleset-insights %}

content/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Forks _do_ inherit push rulesets from their root repository. {% data reusables.r
3434
To import one of the prebuilt rulesets by {% data variables.product.prodname_dotcom %}, see [`github/ruleset-recipes`](https://github.com/github/ruleset-recipes).
3535

3636
{% ifversion repo-rules-management %}
37-
{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#importing-a-ruleset).{% endif %}
37+
{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#using-ruleset-history).{% endif %}
3838

3939
## Using `fnmatch` syntax
4040

content/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can use the REST and GraphQL APIs to manage rulesets. For more information,
4343
{% data reusables.organizations.access-ruleset-settings %}
4444
{% data reusables.repositories.delete-ruleset-steps %}
4545

46-
{% ifversion repo-rules-history %}
46+
{% ifversion repo-rules-management %}
4747

4848
## Using ruleset history
4949

@@ -56,11 +56,7 @@ You can use the REST and GraphQL APIs to manage rulesets. For more information,
5656
{% data reusables.organizations.access-ruleset-settings %}
5757
{% data reusables.repositories.ruleset-history %}
5858

59-
{% endif %}
60-
61-
{% ifversion repo-rules-management %}
62-
63-
## Importing a ruleset
59+
### Importing a ruleset
6460

6561
You can import a ruleset from another repository or organization using the exported JSON file from the previous section. This can be useful if you want to apply the same ruleset to multiple repositories or organizations.
6662

content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ For customers on {% data variables.product.prodname_team %} and {% data variable
3434

3535
To import one of the prebuilt rulesets by {% data variables.product.prodname_dotcom %}, see [`github/ruleset-recipes`](https://github.com/github/ruleset-recipes).
3636

37-
{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#importing-a-ruleset).{% endif %}
37+
{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#using-ruleset-history).{% endif %}
3838

3939
## Using `fnmatch` syntax
4040

content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,31 +73,31 @@ You can also view active ruselets:
7373
{% data reusables.repositories.repo-rulesets-settings %}
7474
{% data reusables.repositories.delete-ruleset-steps %}
7575

76-
{% ifversion repo-rules-history %}
77-
78-
## Using ruleset history
76+
{% ifversion repo-rules-management %}
7977

80-
{% data reusables.repositories.ruleset-beta-note %}
78+
## Importing a ruleset
8179

82-
{% data reusables.repositories.ruleset-history-conceptual %}
80+
{% data reusables.repositories.import-a-ruleset-conceptual %}
8381

8482
{% data reusables.repositories.navigate-to-repo %}
8583
{% data reusables.repositories.sidebar-settings %}
8684
{% data reusables.repositories.repo-rulesets-settings %}
87-
{% data reusables.repositories.ruleset-history %}
85+
{% data reusables.repositories.import-a-ruleset %}
8886

8987
{% endif %}
9088

91-
{% ifversion repo-rules-management %}
89+
{% ifversion repo-rules-enterprise %}
9290

93-
## Importing a ruleset
91+
## Using ruleset history
9492

95-
{% data reusables.repositories.import-a-ruleset-conceptual %}
93+
{% data reusables.repositories.ruleset-beta-note %}
94+
95+
{% data reusables.repositories.ruleset-history-conceptual %}
9696

9797
{% data reusables.repositories.navigate-to-repo %}
9898
{% data reusables.repositories.sidebar-settings %}
9999
{% data reusables.repositories.repo-rulesets-settings %}
100-
{% data reusables.repositories.import-a-ruleset %}
100+
{% data reusables.repositories.ruleset-history %}
101101

102102
## Viewing insights for rulesets
103103

data/features/repo-rules-history.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

data/features/repo-rules-management.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Reference: #11915 and #16558
2-
# Ruleset management (import/export) public preview and GA
2+
# Ruleset management public preview and GA
33
versions:
44
fpt: '*'
55
ghec: '*'

data/release-notes/enterprise-server/3-17/0-rc1.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@ sections:
118118
# https://github.com/github/releases/issues/4042
119119
- |
120120
Push rulesets are generally available. Users can block pushes to private and internal repositories, and their forks, based on file type, path, or size. Unlike pre-receive hooks, push rules are built-in, configurable via the UI or API, and support audit logs, evaluate mode, and bypass lists. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#push-rulesets).
121+
# https://github.com/github/releases/issues/5128
122+
- |
123+
Enterprise administrators can manage rules more efficiently with the general availability of ruleset history, import, and export. Ruleset history allows tracking and rolling back changes, while import and export simplify sharing and reusing rulesets, including GitHub's ruleset-recipes. See [`github/ruleset-recipes`](https://github.com/github/ruleset-recipes).
121124
# https://github.com/github/releases/issues/5129
122125
- |
123126
Repository administrators can easily convert a fork into a standalone repository by leaving the fork network, which stops automatic syncing with the upstream repository. This is useful for taking a project in a new direction or maintaining separate versions.

0 commit comments

Comments
 (0)