Skip to content

Commit 5354963

Browse files
committed
Merge branch 'github-premium-support' of github.com:github/docs-internal into github-premium-support
2 parents befaedb + 41e9919 commit 5354963

10 files changed

Lines changed: 69 additions & 12 deletions

File tree

content/admin/enterprise-management/about-geo-replication.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Geo DNS, such as [Amazon's Route 53 service](http://docs.aws.amazon.com/Route53/
2222

2323
Writing requests to the replica requires sending the data to the primary and all replicas. This means that the performance of all writes are limited by the slowest replica, although new geo-replicas can seed the majority of their data from existing co-located geo-replicas, rather than from the primary. Geo-replication will not add capacity to a {% data variables.product.prodname_ghe_server %} instance or solve performance issues related to insufficient CPU or memory resources. If the primary appliance is offline, active replicas will be unable to serve any read or write requests.
2424

25+
{% data reusables.enterprise_installation.replica-limit %}
26+
2527
### Monitoring a geo-replication configuration
2628

2729
{% data reusables.enterprise_installation.monitoring-replicas %}

content/admin/enterprise-management/about-high-availability-configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ When you configure high availability, there is an automated setup of one-way, as
1414

1515
{% data variables.product.prodname_ghe_server %} supports an active/passive configuration, where the replica appliance runs as a standby with database services running in replication mode but application services stopped.
1616

17+
{% data reusables.enterprise_installation.replica-limit %}
18+
1719
### Targeted failure scenarios
1820

1921
Use a high availability configuration for protection against:

content/admin/enterprise-management/creating-a-high-availability-replica.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ topics:
1010
- enterprise
1111
---
1212

13+
{% data reusables.enterprise_installation.replica-limit %}
14+
1315
### Creating a high availability replica
1416

1517
1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see ["Setting up a {% data variables.product.prodname_ghe_server %} instance"](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance).

content/admin/user-management/customizing-user-messages-for-your-enterprise.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,21 @@ You can use Markdown to format your message. For more information, see "[About w
6464
{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
6565
### Creating a mandatory message
6666

67-
You can create a mandatory message that {% data variables.product.product_name %} will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use {% data variables.product.product_location %}. Mandatory messages have a variety of uses.
67+
You can create a mandatory message that {% data variables.product.product_name %} will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use {% data variables.product.product_location %}.
68+
69+
Mandatory messages have a variety of uses.
6870

6971
- Providing onboarding information for new employees
7072
- Telling users how to get help with {% data variables.product.product_location %}
7173
- Ensuring that all users read your terms of service for using {% data variables.product.product_location %}
7274

75+
{% note %}
76+
77+
**Note:** After you configure a mandatory message for {% data variables.product.product_location %}, you cannot change or remove the message.
78+
79+
{% endnote %}
80+
81+
7382
If you include Markdown checkboxes in the message, all checkboxes must be selected before the user can dismiss the message. For example, if you include your terms of service in the mandatory message, you can require that each user selects a checkbox to confirm the user has read the terms.
7483

7584
Each time a user sees a mandatory message, an audit log event is created. The event includes the version of the message that the user saw. For more information see "[Audited actions](/admin/user-management/audited-actions)."

content/code-security/secure-coding/configuring-code-scanning.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,22 @@ Scanning code when someone pushes a change, and whenever a pull request is creat
5151

5252
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)."
5353

54+
If you scan on push, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
55+
56+
{% note %}
57+
58+
**Note**: If you want {% data variables.product.prodname_code_scanning %} alerts to appear as pull request checks, you must use the `pull_request` event, described below.
59+
60+
{% endnote %}
61+
5462
#### Scanning pull requests
5563

5664
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
5765

5866
For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)."
5967

68+
If you scan pull requests, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
69+
6070
#### Avoiding unnecessary scans of pull requests
6171

6272
You might want to avoid a code scan being triggered on specific pull requests targeted against the default branch, irrespective of which files have been changed. You can configure this by specifying `on:pull_request:paths-ignore` or `on:pull_request:paths` in the {% data variables.product.prodname_code_scanning %} workflow. For example, if the only changes in a pull request are to files with the file extensions `.md` or `.txt` you can use the following `paths-ignore` array.

content/github/authenticating-to-github/telling-git-about-your-signing-key.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ If you have multiple GPG keys, you need to tell Git which one to use.
3131
{% data reusables.gpg.list-keys-with-note %}
3232
{% data reusables.gpg.copy-gpg-key-id %}
3333
{% data reusables.gpg.paste-gpg-key-id %}
34-
1. If you aren't using the GPG suite, paste the text below to add the GPG key to your bash profile:
34+
1. If you aren't using the GPG suite, run the following command in the `zsh` shell to add the GPG key to your `.zshrc` file, if it exists, or your `.zprofile` file:
3535
```shell
36-
$ test -r ~/.bash_profile && echo 'export GPG_TTY=$(tty)' >> ~/.bash_profile
37-
$ echo 'export GPG_TTY=$(tty)' >> ~/.profile
36+
$ if [ -r ~/.zshrc ]; then echo 'export GPG_TTY=$(tty)' >> ~/.zshrc; \
37+
else echo 'export GPG_TTY=$(tty)' >> ~/.zprofile; fi
38+
```
39+
Alternatively, if you use the `bash` shell, run this command:
40+
```shell
41+
$ if [ -r ~/.bash_profile ]; then echo 'export GPG_TTY=$(tty)' >> ~/.bash_profile; \
42+
else echo 'export GPG_TTY=$(tty)' >> ~/.profile; fi
3843
```
39-
{% note %}
40-
41-
**Note:** If you don't have `.bash_profile`, this command adds your GPG key to `.profile`.
42-
43-
{% endnote %}
4444

4545
{% data reusables.gpg.x-509-key %}
4646

@@ -93,10 +93,10 @@ If you have multiple GPG keys, you need to tell Git which one to use.
9393
{% data reusables.gpg.list-keys-with-note %}
9494
{% data reusables.gpg.copy-gpg-key-id %}
9595
{% data reusables.gpg.paste-gpg-key-id %}
96-
1. To add your GPG key to your bash profile, paste the text below:
96+
1. To add your GPG key to your bash profile, run the following command:
9797
```shell
98-
$ test -r ~/.bash_profile && echo 'export GPG_TTY=$(tty)' >> ~/.bash_profile
99-
$ echo 'export GPG_TTY=$(tty)' >> ~/.profile
98+
$ if [ -r ~/.bash_profile ]; then echo 'export GPG_TTY=$(tty)' >> ~/.bash_profile; \
99+
else echo 'export GPG_TTY=$(tty)' >> ~/.profile; fi
100100
```
101101
{% note %}
102102

data/release-notes/2-21/17.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,11 @@ sections:
1515
- Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.
1616
- When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.
1717
- Security alerts are not reported when pushing to a repository on the command line.
18+
- |
19+
Log rotation may fail to signal services to transition to new log files, leading to older log files continuing to be used, and eventual root disk space exhaustion.
20+
To remedy and/or prevent this issue, run the following commands in the [administrative shell](https://docs.github.com/en/enterprise-server/admin/configuration/accessing-the-administrative-shell-ssh) (SSH), or contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/) for assistance:
21+
22+
```
23+
printf "PATH=/usr/local/sbin:/usr/local/bin:/usr/local/share/enterprise:/usr/sbin:/usr/bin:/sbin:/bin\n29,59 * * * * root /usr/sbin/logrotate /etc/logrotate.conf\n" | sudo sponge /etc/cron.d/logrotate
24+
sudo /usr/sbin/logrotate -f /etc/logrotate.conf
25+
```

data/release-notes/2-22/9.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,11 @@ sections:
2121
- Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.
2222
- Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.
2323
- When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.
24+
- |
25+
Log rotation may fail to signal services to transition to new log files, leading to older log files continuing to be used, and eventual root disk space exhaustion.
26+
To remedy and/or prevent this issue, run the following commands in the [administrative shell](https://docs.github.com/en/enterprise-server/admin/configuration/accessing-the-administrative-shell-ssh) (SSH), or contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/) for assistance:
27+
28+
```
29+
printf "PATH=/usr/local/sbin:/usr/local/bin:/usr/local/share/enterprise:/usr/sbin:/usr/bin:/sbin:/bin\n29,59 * * * * root /usr/sbin/logrotate /etc/logrotate.conf\n" | sudo sponge /etc/cron.d/logrotate
30+
sudo /usr/sbin/logrotate -f /etc/logrotate.conf
31+
```

data/release-notes/3-0/3.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,11 @@ sections:
2828
- When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/).
2929
- Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters.
3030
- reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text.
31+
- |
32+
Log rotation may fail to signal services to transition to new log files, leading to older log files continuing to be used, and eventual root disk space exhaustion.
33+
To remedy and/or prevent this issue, run the following commands in the [administrative shell](https://docs.github.com/en/enterprise-server/admin/configuration/accessing-the-administrative-shell-ssh) (SSH), or contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/) for assistance:
34+
35+
```
36+
printf "PATH=/usr/local/sbin:/usr/local/bin:/usr/local/share/enterprise:/usr/sbin:/usr/bin:/sbin:/bin\n29,59 * * * * root /usr/sbin/logrotate /etc/logrotate.conf\n" | sudo sponge /etc/cron.d/logrotate
37+
sudo /usr/sbin/logrotate -f /etc/logrotate.conf
38+
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% if currentVersion ver_gt "enterprise-server@2.21" %}
2+
{% note %}
3+
4+
**Note:** There is a maximum of 8 high availability replicas (both passive and active/geo replicas) allowed for {% data variables.product.product_name %}.
5+
6+
{% endnote %}
7+
8+
{% endif %}

0 commit comments

Comments
 (0)