forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8291504
commit ebd13e4
Showing
25 changed files
with
210 additions
and
37 deletions.
There are no files selected for viewing
45 changes: 45 additions & 0 deletions
45
.github/ISSUE_TEMPLATE/partner-contributed-documentation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
BIN
+13.4 KB
(130%)
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 %} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)" |
4 changes: 4 additions & 0 deletions
4
data/reusables/dependabot/pull-request-security-vs-version-updates.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.