Skip to content

Commit ebd13e4

Browse files
authored
repo sync (#4487)
1 parent 8291504 commit ebd13e4

File tree

25 files changed

+210
-37
lines changed

25 files changed

+210
-37
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Partner-owned product documentation
3+
about: Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub
4+
title: ''
5+
labels:
6+
- partner
7+
assignees: ''
8+
---
9+
10+
<!--
11+
Thank you for your interest in contributing to the GitHub documentation.
12+
13+
This issue template is only for use by GitHub's Technology Partners who wish to contribute documentation explaining how the partner's product works with GitHub, making it straightforward for our shared customers to adopt the product into their workflow.
14+
15+
As a general guide, we estimate we have bandwidth for prioritizing and reviewing up to 3 partner contributions per quarter.
16+
17+
Please be sure to complete all items in the checklists that follow, and feel free to comment with any questions. A member of the team will be glad to support you.
18+
-->
19+
20+
## Pre-requisites
21+
22+
- [ ] Prior to submitting documentation, please apply to join the GitHub Technology Partner Program: [partner.github.com/apply](https://partner.github.com/apply?partnershipType=Technology+Partner). Please feel free to proceed once your application is approved.
23+
24+
## Tasks
25+
26+
Please be sure to complete each of the following:
27+
28+
**Third-party product documentation:**
29+
30+
- [ ] MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
31+
- [ ] MUST emphasize how the third-party product works with GitHub.
32+
- [ ] MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates)
33+
- [ ] MUST include the name and URL of the GitHub technology partner responsible for maintenance of the documentation being contributed. This should be added via the `contributor.name` and `contributor.URL` properties in the template's YAML frontmatter.
34+
- [ ] MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/).
35+
- [ ] MUST be located in the root of [the `content` folder](content). Your filename MUST match the GitHub technology partner name, and use the `.md` file extension.
36+
37+
**The `Pull Request`:**
38+
39+
- [ ] MUST reference this issue, e.g. via `closes #<this issue number>`
40+
- [ ] MUST pass the automated CI checks
41+
- [ ] MUST include links to supporting material demonstrating the functionality being documented (this can be a link to a public GitHub repo, _or_ a video / screencast walkthrough)
42+
43+
Once all tasks are completed, please mention `@github/docs-content` for next steps.
44+
45+
/cc @github/partner-engineering for :eyes:
13.4 KB
Loading
-13.8 KB
Loading

content/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
2525
- [`includeGuides`](#includeGuides)
2626
- [`type`](#type)
2727
- [`topics`](#topics)
28+
- [`contributor`](#contributor)
2829
- [Escaping single quotes](#escaping-single-quotes)
2930
- [Autogenerated mini TOCs](#autogenerated-mini-tocs)
3031
- [Versioning](#versioning)
@@ -231,6 +232,18 @@ includeGuides:
231232
- Type: `String`
232233
- Optional.
233234

235+
### `contributor`
236+
- Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner.
237+
- Type: `Object`. Properties are `name` and `URL`.
238+
- Optional.
239+
240+
Example:
241+
242+
```yml
243+
contributor:
244+
name: ACME, inc.
245+
URL: https://acme.example.com/
246+
```
234247

235248
### Escaping single quotes
236249

content/admin/enterprise-management/upgrading-github-enterprise-server.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,12 @@ Increased requirements for {% data variables.product.prodname_ghe_server %} 3.0
4545
| 5,000 to 8000 | **16**<br/>_Up from 12_ | 96 GB | 750 GB | 200 GB |
4646
| 8,000 to 10,000+ | **20**<br/>_Up from 16_ | **160 GB**<br/>_Up from 128 GB_ | 1000 GB | 200 GB |
4747

48+
{% if currentVersion ver_gt "enterprise-server@2.21" %}
49+
4850
For more information about hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)."
4951

52+
{% endif %}
53+
5054
{% data reusables.enterprise_installation.about-adjusting-resources %}
5155

5256
{% endif %}

content/github/administering-a-repository/about-dependabot-version-updates.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ When {% data variables.product.prodname_dependabot %} identifies an outdated dep
2222

2323
If you enable security updates, {% data variables.product.prodname_dependabot %} also raises pull requests to update vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
2424

25+
{% data reusables.dependabot.pull-request-security-vs-version-updates %}
26+
2527
{% data reusables.dependabot.dependabot-tos %}
2628

2729
### Frequency of {% data variables.product.prodname_dependabot %} pull requests

content/github/administering-a-repository/configuration-options-for-dependency-updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,7 @@ updates:
551551
552552
### `vendor`
553553

554-
Use the `vendor` option to tell {% data variables.product.prodname_dependabot %} to vendor dependencies when updating them.
554+
Use the `vendor` option to tell {% data variables.product.prodname_dependabot %} to vendor dependencies when updating them. Don't use this option if you're using `gomod` as {% data variables.product.prodname_dependabot %} automatically detects vendoring for this tool.
555555

556556
```yaml
557557
# Configure version updates for both dependencies defined in manifests and vendored dependencies

content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ The {% data variables.product.prodname_dependabot_security_updates %} feature is
2222

2323
{% endnote %}
2424

25+
You can enable a related feature, {% data variables.product.prodname_dependabot_version_updates %}, so that {% data variables.product.prodname_dependabot %} raises pull requests to update the manifest to the latest version of the dependency, whenever it detects an outdated dependency. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)."
26+
27+
{% data reusables.dependabot.pull-request-security-vs-version-updates %}
28+
2529
### About pull requests for security updates
2630

2731
Each pull request contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_alerts %} for the repository.

content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ You can enable or disable features for all repositories. {% if currentVersion ==
7676
![Button to enable feature for all the eligible repositories in the organization](/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png)
7777
{% endif %}
7878

79+
{% data reusables.security.displayed-information %}
80+
7981
### Enabling or disabling a feature automatically when new repositories are added
8082

8183
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."

content/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ For an overview of repository-level security, see "[About securing your reposito
2828
7. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories you own.
2929
![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png)
3030

31+
{% data reusables.security.displayed-information %}
32+
3133
### Enabling or disabling features for new repositories
3234

3335
{% data reusables.user_settings.access_settings %}

0 commit comments

Comments
 (0)