Skip to content

Commit

Permalink
repo sync (github#4487)
Browse files Browse the repository at this point in the history
  • Loading branch information
Octomerger authored Mar 12, 2021
1 parent 8291504 commit ebd13e4
Show file tree
Hide file tree
Showing 25 changed files with 210 additions and 37 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/partner-contributed-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Partner-owned product documentation
about: Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub
title: ''
labels:
- partner
assignees: ''
---

<!--
Thank you for your interest in contributing to the GitHub documentation.
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.
As a general guide, we estimate we have bandwidth for prioritizing and reviewing up to 3 partner contributions per quarter.
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.
-->

## Pre-requisites

- [ ] 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.

## Tasks

Please be sure to complete each of the following:

**Third-party product documentation:**

- [ ] MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
- [ ] MUST emphasize how the third-party product works with GitHub.
- [ ] MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates)
- [ ] 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.
- [ ] MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/).
- [ ] 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.

**The `Pull Request`:**

- [ ] MUST reference this issue, e.g. via `closes #<this issue number>`
- [ ] MUST pass the automated CI checks
- [ ] 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)

Once all tasks are completed, please mention `@github/docs-content` for next steps.

/cc @github/partner-engineering for :eyes:
Binary file modified assets/images/help/repository/code-scanning-branch-dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/code-scanning-click-alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
- [`includeGuides`](#includeGuides)
- [`type`](#type)
- [`topics`](#topics)
- [`contributor`](#contributor)
- [Escaping single quotes](#escaping-single-quotes)
- [Autogenerated mini TOCs](#autogenerated-mini-tocs)
- [Versioning](#versioning)
Expand Down Expand Up @@ -231,6 +232,18 @@ includeGuides:
- Type: `String`
- Optional.

### `contributor`
- Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner.
- Type: `Object`. Properties are `name` and `URL`.
- Optional.

Example:

```yml
contributor:
name: ACME, inc.
URL: https://acme.example.com/
```

### Escaping single quotes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,12 @@ Increased requirements for {% data variables.product.prodname_ghe_server %} 3.0
| 5,000 to 8000 | **16**<br/>_Up from 12_ | 96 GB | 750 GB | 200 GB |
| 8,000 to 10,000+ | **20**<br/>_Up from 16_ | **160 GB**<br/>_Up from 128 GB_ | 1000 GB | 200 GB |

{% if currentVersion ver_gt "[email protected]" %}

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)."

{% endif %}

{% data reusables.enterprise_installation.about-adjusting-resources %}

{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ When {% data variables.product.prodname_dependabot %} identifies an outdated dep

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)."

{% data reusables.dependabot.pull-request-security-vs-version-updates %}

{% data reusables.dependabot.dependabot-tos %}

### Frequency of {% data variables.product.prodname_dependabot %} pull requests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ updates:
### `vendor`

Use the `vendor` option to tell {% data variables.product.prodname_dependabot %} to vendor dependencies when updating them.
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.

```yaml
# Configure version updates for both dependencies defined in manifests and vendored dependencies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ The {% data variables.product.prodname_dependabot_security_updates %} feature is

{% endnote %}

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)."

{% data reusables.dependabot.pull-request-security-vs-version-updates %}

### About pull requests for security updates

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ You can enable or disable features for all repositories. {% if currentVersion ==
![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)
{% endif %}

{% data reusables.security.displayed-information %}

### Enabling or disabling a feature automatically when new repositories are added

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)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ For an overview of repository-level security, see "[About securing your reposito
7. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories you own.
![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png)

{% data reusables.security.displayed-information %}

### Enabling or disabling features for new repositories

{% data reusables.user_settings.access_settings %}
Expand Down
2 changes: 1 addition & 1 deletion content/graphql/guides/managing-enterprise-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A
We recommend you use GraphiQL or another standalone GraphQL client that lets you configure the base URL.

You may also consider using these GraphQL clients:
- [Insomnia](https://insomnia.rest/graphql/)
- [Insomnia](https://support.insomnia.rest/article/176-graphql-queries)
- [GraphiQL](https://www.gatsbyjs.org/docs/running-queries-with-graphiql/)
- [Postman](https://learning.getpostman.com/docs/postman/sending_api_requests/graphql/)

Expand Down
19 changes: 19 additions & 0 deletions contributing/github-partners/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# GitHub Partners

This folder contains templates to be used by GitHub's technology partners when contributing documentation, such as guides.

To get started, please [open an issue using this link](https://github.com/github/docs/issues/new?template=partner-contributed-documentation.md).

## Templates

### Tutorial template
Tutorials guide the reader through an entire workflow to complete a task.

You should consider creating a tutorial when:

- The user has a basic understanding of the product and is interested in extending their use and understanding to solve a specific problem.
- The user is looking for expert advice and a detailed discussion on best practices related their problem.
- The user may have implemented a similar solution in the past using a different product.
- The user wants to validate whether the solution is appropriate for their needs.

Get started with this template [here](tutorial.md).
56 changes: 56 additions & 0 deletions contributing/github-partners/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Tutorial title
intro: 'Article intro. See tips for a great intro below'
product: '{{ optional product callout }}'
productVersions:
contributor:
name:
URL:
---

<!-- Remember to add the tutorial title, intro, product version, contributor name, and contributor URL above -->
<!-- Great intros clarify who the tutorial is intended for, state what the user will accomplish, state the technology(ies) that will be used.-->

### Introduction

<!-- The tutorial introduction should include the following in a short paragraph:
- Clarify audience
- State prerequisites and prior knowledge needed
- State what the user will accomplish or build and the user problem it solves
- Link to an example of the project the user will complete -->

### Step 1: Action the user will take

<!-- In one sentence, describe what the user will do in this step -->
<!-- Steps should break down the tasks the user will complete in sequential order -->
<!-- Avoid replicating conceptual information that is covered elsewhere, provide inline links instead. Only include conceptual information unique to this use case. -->

#### Task chunk

<!-- A step may require the user to perform several tasks - break those tasks down into chunks, allowing the user to scan quickly to find their place if they navigated away from this screen to perform the task. -->
<!-- An example might be creating a PAT for the action to use and then storing it in secrets -->
<!-- For UI based tasks, include the button or options the users should click -->
<!-- If the task adds code, include the code in context (don't just show `needs: setup` show the entire `setup` and `dependent` jobs) -->

#### Another task chunk

<!-- remove all of these comments when you're done -->

### Step 2: Do the next thing

<!-- Rinse and repeat, adding steps and tasks until the tutorial is complete
<!-- remember to show code snippets in context -->

```yaml
on:
schedule:
- cron: "40 19 * * *"
```
### Further reading
<!-- include a bulleted list of tutorials or articles the user can reference to extend the concepts taught in this tutorial -->
- "[Article title](article-URL)"
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
When {% data variables.product.prodname_dependabot %} raises pull requests, these pull requests could be for _security_ or _version_ updates:

- {% data variables.product.prodname_dependabot_security_updates %} are automated pull requests that help you update dependencies with known vulnerabilities.
- {% data variables.product.prodname_dependabot_version_updates %} are automated pull requests that keep your dependencies updated, even when they don’t have any vulnerabilities. To check the status of version updates, navigate to the Insights tab of your repository, then Dependency Graph, and {% data variables.product.prodname_dependabot %}.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Partner | Supported secret | API slug
--- | --- | ---
Partner | Supported secret | API slug
--- | --- | ---
n/a | JSON Web Token | json_web_token
n/a | OAuth Client Credential | api_credential_assignment
Adafruit IO | Adafruit IO Key | adafruit_io_key
Expand Down Expand Up @@ -51,6 +51,7 @@ Proctorio | Proctorio Secret Key | proctorio_secret_key
Pulumi | Pulumi Access Token | pulumi_access_token
Samsara | Samsara API Token | samsara_api_token
Samsara | Samsara OAuth Access Token | samsara_oauth_access_token
SendGrid | SendGrid API Key | sendgrid_api_key
Shopify | Shopify App Shared Secret | shopify_app_shared_secret
Shopify | Shopify Access Token | shopify_access_token
Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token
Expand Down
7 changes: 7 additions & 0 deletions data/reusables/security/displayed-information.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
When you enable one or more security and analysis features for existing repositories, you will see any results displayed on {% data variables.product.prodname_dotcom %} within minutes:

- All the existing repositories will have the selected configuration.
- New repositories will follow the selected configuration if you've enabled the checkbox for new repositories.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
- We use the permissions to scan for manifest files to apply the relevant services.
- You'll see information on your dependency graph.
- {% data variables.product.prodname_dotcom %} will generate {% data variables.product.prodname_dependabot_alerts %}{% endif %}{% if currentVersion == "free-pro-team@latest" %} and raise pull requests{% endif %}.
1 change: 1 addition & 0 deletions data/ui.yml
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,4 @@ product_sublanding:
learning_track_nav:
prevGuide: Previous guide
nextGuide: Next guide
contributor_callout: This article is contributed and maintained by
6 changes: 6 additions & 0 deletions includes/article.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ <h1 class="border-bottom-0">{{ page.title }}</h1>
</div>
</div>

{% if page.contributor %}
<div class="contributor-callout border rounded-1 mb-4 p-3 border-blue bg-blue-light f5">
<p><span class="mr-2">{% octicon "info" %}</span>{% data ui.contributor_callout %} <a href="{{ page.contributor.URL }}">{{ page.contributor.name }}</a>.</p>
</div>
{% endif %}

{% if page.intro %}
<div class="lead-mktg">{{ page.intro }}</div>
{% endif %}
Expand Down
8 changes: 8 additions & 0 deletions lib/frontmatter.js
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,14 @@ const schema = {
defaultPlatform: {
type: 'string',
enum: ['mac', 'windows', 'linux']
},
// Documentation contributed by a third party, such as a GitHub Partner
contributor: {
type: 'object',
properties: {
name: { type: 'string' },
URL: { type: 'string' }
}
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"html_url": "https://github.com/Codertocat/Hello-World/security/code-scanning/10",
"instances": [
{
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/workflow.yml:upload",
"environment": "{}",
"state": "open"
Expand All @@ -27,7 +27,7 @@
"version": null
}
},
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
"repository": {
"id": 186853002,
Expand Down Expand Up @@ -121,7 +121,7 @@
"forks": 0,
"open_issues": 2,
"watchers": 0,
"default_branch": "master"
"default_branch": "main"
},
"organization": {
"login": "Octocoders",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10",
"instances": [
{
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/workflow.yml:upload",
"environment": "{}",
"state": "open"
Expand All @@ -27,7 +27,7 @@
"version": null
}
},
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
"repository": {
"id": 186853002,
Expand Down Expand Up @@ -121,7 +121,7 @@
"forks": 0,
"open_issues": 2,
"watchers": 0,
"default_branch": "master"
"default_branch": "main"
},
"organization": {
"login": "Octocoders",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10",
"instances": [
{
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/workflow.yml:upload",
"environment": "{}",
"state": "open"
Expand All @@ -27,7 +27,7 @@
"version": null
}
},
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
"repository": {
"id": 186853002,
Expand Down Expand Up @@ -121,7 +121,7 @@
"forks": 0,
"open_issues": 2,
"watchers": 0,
"default_branch": "master"
"default_branch": "main"
},
"organization": {
"login": "Octocoders",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"html_url": "https://octocoders.github.io/Codertocat/Hello-World/security/code-scanning/10",
"instances": [
{
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/workflow.yml:upload",
"environment": "{}",
"state": "open"
Expand All @@ -27,7 +27,7 @@
"version": null
}
},
"ref": "refs/heads/master",
"ref": "refs/heads/main",
"commit_oid": "d6e4c75c141dbacecc279b721b8b9393d5405795",
"repository": {
"id": 186853002,
Expand Down Expand Up @@ -121,7 +121,7 @@
"forks": 0,
"open_issues": 2,
"watchers": 0,
"default_branch": "master"
"default_branch": "main"
},
"organization": {
"login": "Octocoders",
Expand Down
Loading

0 comments on commit ebd13e4

Please sign in to comment.