Skip to content
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ff7ab2f
Merge branch 'main' into repo-sync
Octomerger May 4, 2021
66f7874
Merge pull request #19134 from github/repo-sync
Octomerger May 4, 2021
3d621ba
Start an AB test with Lunr search results as treatment (#18993)
heiskr May 4, 2021
a55d1e9
Action ran graphql script"update-files"
rachmari May 4, 2021
be8aa2b
Add tabs for cli/desktop/ui (#19071)
May 4, 2021
b606fdb
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger May 4, 2021
ac87a84
Merge branch 'main' into repo-sync
Octomerger May 4, 2021
abe81c0
GraphQL schema update
Octomerger May 4, 2021
33e5991
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger May 4, 2021
492d834
Merge pull request #19138 from github/repo-sync
Octomerger May 4, 2021
2750073
Add an option to opt issues and PRs out of HWW boards (#19135)
chiedo May 4, 2021
1a7e777
One product variable to rule them all (#19115)
jmarlena May 4, 2021
691155b
Tidy up broken links (#19142)
jmarlena May 4, 2021
0b4e790
run script/i18n/homogenize-frontmatter.js (#19118)
zeke May 4, 2021
c4190f9
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger May 4, 2021
31b84e5
Merge pull request #19144 from github/repo-sync
Octomerger May 4, 2021
23c7175
Migrate content model and templates to the public repo (#19141)
emilyistoofunky May 4, 2021
a417401
`opened` isn't a valid activity type for `project_card` (#19130)
aybabtme May 4, 2021
67e75a6
Merge branch 'main' into repo-sync
Octomerger May 5, 2021
68b235b
Merge pull request #19149 from github/repo-sync
Octomerger May 5, 2021
7dc54c5
authors cannot approve their own pull requests (#19116)
chiph May 5, 2021
eaddbc5
feat: add nextjs middleware handling (#19139)
mikesurowiec May 5, 2021
6187dc4
Update info on notifications to include new "security alerts" type (#…
felicitymay May 5, 2021
d9c336f
add custom popular heading to landing pages (#19147)
rachmari May 5, 2021
29e2006
exit with logging message (#19137)
rachmari May 5, 2021
a5bc762
Deprecating Dependabot elm 0.18 support (#19133)
asciimike May 5, 2021
46fda7b
[DO NOT MERGE] GitHub Enterprise Server 3.1 release candidate megabra…
rachmari May 6, 2021
57e1a1b
End Lunr AB test (#19155)
heiskr May 6, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
6 changes: 3 additions & 3 deletions .github/workflows/send-issues-to-how-how-we-work-boards.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
continue-on-error: true
steps:
- if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'batch') && !contains(github.event.issue.labels.*.name, 'epic')
- if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'no-hww-board') && !contains(github.event.issue.labels.*.name, 'batch') && !contains(github.event.issue.labels.*.name, 'epic')
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
with:
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
Expand All @@ -31,7 +31,7 @@ jobs:
} catch (error) {
console.log(error);
}
- if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'batch')
- if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'no-hww-board') && contains(github.event.issue.labels.*.name, 'batch')
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
with:
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
Expand All @@ -46,7 +46,7 @@ jobs:
} catch (error) {
console.log(error);
}
- if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic')
- if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'no-hww-board') && contains(github.event.issue.labels.*.name, 'epic')
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
with:
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/send-prs-to-how-how-we-work-boards.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
continue-on-error: true
steps:
- if: (github.repository == 'github/docs-internal') && contains(github.event.pull_request.labels.*.name, 'batch')
- if: (github.repository == 'github/docs-internal') && !contains(github.event.issue.labels.*.name, 'no-hww-board') && contains(github.event.pull_request.labels.*.name, 'batch')
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
with:
github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ coverage/
/content/early-access
/data/early-access
dist
.next

# blc: broken link checker
blc_output.log
Expand Down
14 changes: 11 additions & 3 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
{
"overrides": [
{
"files":[
"**/*.{yml,yaml}"
],
"files": ["**/*.{yml,yaml}"],
"options": {
"singleQuote": true
}
},
{
"files": ["**/*.{ts,tsx}"],
"options": {
"semi": false,
"singleQuote": true,
"printWidth": 100,
"jsxBracketSameLine": false,
"arrowParens": "always"
}
}
]
}
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ Here's some information that might be helpful while working on a Docs PR:

- [Content style guide for GitHub Docs](/contributing/content-style-guide.md) - This guide covers GitHub-specific information about how we style our content and images. It also links to the resources we use for general style guidelines.

- [Content model](/contributing/content-model.md) and [content templates](/contributing/content-templates.md) - The content model describes the purpose of each type of content we use in GitHub Docs and how to write for each type. The templates allow you to quickly get started with new articles.

- [Reusables](/data/reusables/README.md) - We use reusables to help us keep content up to date. Instead of writing the same long string of information in several articles, we create a reusable, then call it from the individual articles.

- [Variables](/data/variables/README.md) - We use variables the same way we use reusables. Variables are for short strings of reusable text.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions components/ExampleComponent.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export const ExampleComponent = () => {
return <div>Welcome to Next.JS land!</div>
}
11 changes: 11 additions & 0 deletions content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
- [`miniTocMaxHeadingLevel`](#minitocmaxheadinglevel)
- [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename)
- [`defaultPlatform`](#defaultplatform)
- [`defaultTool`](#defaulttool)
- [`learningTracks`](#learningTracks)
- [`includeGuides`](#includeGuides)
- [`type`](#type)
Expand Down Expand Up @@ -202,6 +203,16 @@ Example:
defaultPlatform: linux
```

### `defaultTool`

- Purpose: Override the initial tool selection for a page, where tool refers to the application the reader is using to work with GitHub, such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop. If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. This behavior can be changed for individual pages, for which a manual selection is more reasonable.
- Type: `String`, one of: `webui`, `cli`, `desktop`.
- Optional.

```yaml
defaultTool: cli
```

### `learningTracks`
- Purpose: Render a list of learning tracks on a product's sub-landing page.
- type: `String`. This should reference learning tracks' names defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
Expand Down
2 changes: 1 addition & 1 deletion content/actions/reference/events-that-trigger-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ For example, you can run a workflow when a project card has been `opened` or `de
```yaml
on:
project_card:
types: [opened, deleted]
types: [created, deleted]
```

#### `project_column`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -695,11 +695,11 @@ jobs:
```

{% if currentVersion == "free-pro-team@latest" %}
##### Example using the {% data variables.product.prodname_registry %} {% data variables.product.prodname_capitalized_container_registry %}
##### Example using the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}

`docker://{host}/{image}:{tag}`

A Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_capitalized_container_registry %}.
A Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}.

```yaml
jobs:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ You can use a *secret_scanning.yml* file to exclude directories from {% data var

{% endnote %}

You can also ignore individual alerts from {% data variables.product.prodname_secret_scanning %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-alerts)."
You can also ignore individual alerts from {% data variables.product.prodname_secret_scanning %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning#managing-secret-scanning-alerts)."

### Further reading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ topics:

{% data reusables.secret-scanning.beta %}

### Managing alerts
### Managing {% data variables.product.prodname_secret_scanning %} alerts

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %}
Expand Down Expand Up @@ -49,3 +49,11 @@ Once a secret has been committed to a repository, you should consider the secret

- For a compromised {% data variables.product.prodname_dotcom %} personal access token, delete the compromised token, create a new token, and update any services that use the old token. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)."
- For all other secrets, first verify that the secret committed to {% data variables.product.product_name %} is valid. If so, create a new secret, update any services that use the old secret, and then delete the old secret.

{% if currentVersion == "free-pro-team@latest" %}
### Configuring notifications for {% data variables.product.prodname_secret_scanning %} alerts

When a new secret is detected, {% data variables.product.prodname_dotcom %} notifies all users with access to security alerts for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts, or are the author of the commit that contains the secret and are not ignoring the repository.

For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" and "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)."
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,8 @@ You can choose to receive ongoing updates about specific activity on {% data var
You can choose to subscribe to notifications for:
- A conversation in a specific issue, pull request, or gist.
- All activity in a repository or team discussion.
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}.
{% if currentVersion == "free-pro-team@latest" %}
- Issues, pulls requests, releases and discussions (if enabled) in a repository.
{% endif %}
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "[email protected]" %}
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}.{% if currentVersion == "free-pro-team@latest" %}
- Issues, pulls requests, releases, security alerts, and discussions (if enabled) in a repository.{% endif %}{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "[email protected]" %}
- Releases in a repository.
{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In addition, you can receive and triage notifications on your mobile device with

#### Benefits of using an email client for notifications

One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months unless you've marked them as **Saved**. **Saved** notifications are kept indefinitely. For more information about your inbox's retention policy, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)."
One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months on {% data variables.product.prodname_dotcom %} unless you've marked them as **Saved**. **Saved** notifications are kept indefinitely. For more information about your inbox's retention policy, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notification-retention-policy)."

Sending notifications to your email client also allows you to customize your inbox according to your email client's settings, which can include custom or color-coded labels.

Expand All @@ -71,11 +71,12 @@ To see repositories that you're watching, go to your [watching page](https://git
{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "[email protected]" %}
#### Configuring notifications
{% endif %}
You can configure notifications for a repository on the repository page, or on your watching page.{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "[email protected]" %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %}{% if currentVersion == "free-pro-team@latest" %}
You can configure notifications for a repository on the repository page, or on your watching page.{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "[email protected]" %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %}

{% if currentVersion == "free-pro-team@latest" %}
#### About custom notifications
{% data reusables.notifications-v2.custom-notifications-beta %}
You can customize notifications for a repository, for example, you can choose to only be notified when updates to one or more types of events (issues, pull request, releases, discussions) happen within a repository, or ignore all notifications for a repository.
You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events (issues, pull request, releases, security alerts, discussions) happen within a repository, or ignore all notifications for a repository.
{% endif %} For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below.

#### Participating in conversations
Expand Down Expand Up @@ -156,7 +157,7 @@ If "Automatically watch repositories" is disabled, then you will not automatical

### Configuring your watch settings for an individual repository

You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository.
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, security alerts, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository.

{% data reusables.repositories.navigate-to-repo %}
2. In the upper-right corner, click the "Watch" drop-down menu to select a watch option.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
{% if currentVersion == "free-pro-team@latest" %}
- unwatch a repository
- ignore all notifications for a repository
- customize the types of event you receive notifications for (issues, pull requests, releases or discussions, if enabled)
- customize the types of event you receive notifications for (issues, pull requests, releases, security alerts, or discussions, if enabled)
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Many people forget about repositories that they've chosen to watch in the past.

{% tip %}

**Tip:** Instead of watching a repository, consider only receiving notifications {% if currentVersion == "free-pro-team@latest" %}when there are updates to issues, pull requests, releases or discussions (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
**Tip:** Instead of watching a repository, consider only receiving notifications {% if currentVersion == "free-pro-team@latest" %}when there are updates to issues, pull requests, releases, security alerts, or discussions (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.

When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ topics:

{% note %}

**Billing update for container image storage:** During the beta phase of the {% data variables.product.prodname_capitalized_container_registry %}, Docker image storage and bandwidth are free for both the previous `docker.pkg.github.com` and current `ghcr.io` hosting services. For more information, see "[Introduction to {% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages)."
**Billing update for container image storage:** During the beta phase of the {% data variables.product.prodname_container_registry %}, Docker image storage and bandwidth are free for both the previous `docker.pkg.github.com` and current `ghcr.io` hosting services. For more information, see "[Introduction to {% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages)."

{% endnote %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The {% data variables.product.prodname_registry %} registries below use reposito

Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of the package separately from a repository that is connected (or linked) to a package.

Currently, only the {% data variables.product.prodname_capitalized_container_registry %} offers granular permissions for your container image packages.
Currently, only the {% data variables.product.prodname_container_registry %} offers granular permissions for your container image packages.

### Visibility and access permissions for container images

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ versions:

Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of a package separately from the repository that it is connected (or linked) to.

Currently, only the {% data variables.product.prodname_capitalized_container_registry %} offers granular permissions for your container image packages.
Currently, only the {% data variables.product.prodname_container_registry %} offers granular permissions for your container image packages.

For more information about permissions for repository-scoped packages, packages-related scopes for PATs, or managing permissions for your actions workflows, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ By connecting a repository to a package, the package landing page will show info
$ docker tag 38f737a91f39 ghcr.io/monalisa/hello_docker:latest
```

5. If you haven't already, authenticate to the {% data variables.product.prodname_capitalized_container_registry %}. For more information, see "[Authenticating to the {% data variables.product.prodname_capitalized_container_registry %}](/packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images#authenticating-to-the-container-registry)."
5. If you haven't already, authenticate to the {% data variables.product.prodname_container_registry %}. For more information, see "[Authenticating to the {% data variables.product.prodname_container_registry %}](/packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images#authenticating-to-the-container-registry)."
{% raw %}
```shell
$ echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin
> Login Succeeded
```
{% endraw %}
6. Push your container image to the {% data variables.product.prodname_capitalized_container_registry %}.
6. Push your container image to the {% data variables.product.prodname_container_registry %}.
```shell
$ docker push ghcr.io/OWNER/IMAGE-NAME:TAG
```
Expand Down
Loading