Skip to content

Commit

Permalink
Fix text formatting with colon - part 2 (github#35433)
Browse files Browse the repository at this point in the history
Co-authored-by: Alex Nguyen <[email protected]>
  • Loading branch information
akordowski and nguyenalex836 authored Nov 26, 2024
1 parent 56a5520 commit e5877f8
Show file tree
Hide file tree
Showing 39 changed files with 337 additions and 337 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ If you change from **user ownership** to **organization ownership**, existing co
{% data reusables.organizations.click-codespaces %}
{% data reusables.organizations.click-general %}
1. On the {% data variables.product.prodname_codespaces %} settings page, under "Codespace ownership," select the setting you want for your organization:
* **Organization ownership**: Codespaces can be owned and paid for by your organization.
* **User ownership**: Codespaces are always owned and paid for by the user who creates the codespace.
* **Organization ownership:** Codespaces can be owned and paid for by your organization.
* **User ownership:** Codespaces are always owned and paid for by the user who creates the codespace.

1. Optionally, under "Codespaces access," review the members and collaborators for whom you have enabled {% data variables.product.prodname_codespaces %}. These are the only users who can create codespaces that your organization pays for. See "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization)."

Expand Down
12 changes: 6 additions & 6 deletions content/codespaces/reference/security-in-github-codespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ Every time a codespace is created or restarted, it's assigned a new {% data vari

The token's scope will vary depending on the access you have to the repository where the codespace was created:

* **If you have write access to the repository**: The token will be scoped for read/write access to the repository.
* **If you only have read access to the repository**: The token will only allow the code to be cloned from the source repository. If you make a commit in the codespace, or push a new branch, {% data variables.product.prodname_github_codespaces %} automatically creates a fork of the repository, or links the codespace to an existing fork if you already have one for the upstream repository. The token is updated to have read and write access to the fork. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#about-automatic-forking)."
* **If you've authorized your codespace to access other repositories**: The token will be scoped for read or read/write access to the source repository and to any other repositories to which you've authorized access. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces#authorizing-requested-permissions)."
* **If you have write access to the repository:** The token will be scoped for read/write access to the repository.
* **If you only have read access to the repository:** The token will only allow the code to be cloned from the source repository. If you make a commit in the codespace, or push a new branch, {% data variables.product.prodname_github_codespaces %} automatically creates a fork of the repository, or links the codespace to an existing fork if you already have one for the upstream repository. The token is updated to have read and write access to the fork. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#about-automatic-forking)."
* **If you've authorized your codespace to access other repositories:** The token will be scoped for read or read/write access to the source repository and to any other repositories to which you've authorized access. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces#authorizing-requested-permissions)."

### Codespace connections

Expand All @@ -58,11 +58,11 @@ If you need to connect to a service (such as a development web server) running w

Organization owners can restrict the ability to make forward ports available publicly or within the organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)."

**Privately forwarded ports**: Are accessible on the internet, but only the codespace creator can access them, after authenticating to {% data variables.product.product_name %}.
**Privately forwarded ports:** Are accessible on the internet, but only the codespace creator can access them, after authenticating to {% data variables.product.product_name %}.

**Publicly forwarded ports within your organization**: Are accessible on the internet, but only to members of the same organization as the codespace, after authenticating to {% data variables.product.product_name %}.
**Publicly forwarded ports within your organization:** Are accessible on the internet, but only to members of the same organization as the codespace, after authenticating to {% data variables.product.product_name %}.

**Publicly forwarded ports**: Are accessible on the internet, and anyone on the internet can access them. No authentication is needed to access public forwarded ports.
**Publicly forwarded ports:** Are accessible on the internet, and anyone on the internet can access them. No authentication is needed to access public forwarded ports.

All forwarded ports are private by default, which means that you will need to authenticate before you can access the port. Access to a codespace's private forwarded ports is controlled by authentication cookies with a 3-hour expiry period. When the cookie expires, you will need to reauthenticate.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,13 @@ During development, you can visit any page on `http://localhost:4000` and add `?

If your text or code example includes content between curly brackets (`{` and `}`), you need to wrap it between <code>&#123% raw %&#125;</code> and <code>&#123% raw %&#125;</code> tags to disable Liquid processing for that section. For example:

* **Use**:
* **Use:**

<pre>
GITHUB_TOKEN: &#123% raw %&#125;${% raw %}{{ secrets.GITHUB_TOKEN }}{% endraw %}&#123% endraw %&#125;
</pre>

* **Avoid**:
* **Avoid:**

<pre>
GITHUB_TOKEN: ${% raw %}${{ secrets.GITHUB_TOKEN }}${% endraw %}
Expand Down
22 changes: 11 additions & 11 deletions content/contributing/style-guide-and-content-model/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ We document each of the events that may appear in the audit logs for each type o

When writing the description for an audit log event, describe the event that took place in a way that applies to all versions, using past tense and passive voice. Do not begin the sentence with phrases that are already implied by the context of the article, such as "Triggered by."

* **Use**: The visibility of a repository was changed.
* **Use**: Secret scanning was enabled for all new repositories.
* **Avoid**: An organization owner disabled a two-factor authentication requirement for the organization.
* **Avoid**: Triggered when a user updates which repositories a codespace can access.
* **Use:** The visibility of a repository was changed.
* **Use:** Secret scanning was enabled for all new repositories.
* **Avoid:** An organization owner disabled a two-factor authentication requirement for the organization.
* **Avoid:** Triggered when a user updates which repositories a codespace can access.

## Alerts

Expand Down Expand Up @@ -175,13 +175,13 @@ Within code blocks:
```

* If your code example includes `{` or `}` that should render, wrap that section in <code>&#123;% raw %&#125;</code> <code>&#123;% endraw %&#125;</code> to disable Liquid processing for that section.
* **Use**:
* **Use:**

<pre>
GITHUB_TOKEN: &#123;% raw %&#125;$&#123;&#123; secrets.GITHUB_TOKEN &#125;&#125;&#123;% endraw %&#125;
</pre>

* **Avoid**:
* **Avoid:**

<pre>
GITHUB_TOKEN: $&#123;&#123; secrets.GITHUB_TOKEN &#125;&#125;
Expand Down Expand Up @@ -1031,9 +1031,9 @@ A release note for a security fix answers the following questions.
#### Examples of release notes for security fixes
* > **MEDIUM**: An attacker could cause unbounded resource exhaustion on the instance by making parallel requests to the Markdown REST API. To mitigate this issue, {% data variables.product.company_short %} has updated [CommonMarker](https://github.com/gjtorikian/commonmarker). {% data variables.product.company_short %} has requested CVE ID [CVE-2022-39209](https://nvd.nist.gov/vuln/detail/CVE-2022-39209) for this vulnerability.
* > **MEDIUM:** An attacker could cause unbounded resource exhaustion on the instance by making parallel requests to the Markdown REST API. To mitigate this issue, {% data variables.product.company_short %} has updated [CommonMarker](https://github.com/gjtorikian/commonmarker). {% data variables.product.company_short %} has requested CVE ID [CVE-2022-39209](https://nvd.nist.gov/vuln/detail/CVE-2022-39209) for this vulnerability.
* > **MEDIUM**: An attacker could embed dangerous links in the instance's web UI because pull request preview links did not properly sanitize URLs. This vulnerability was reported via the [{% data variables.product.company_short %} Bug Bounty program](https://bounty.github.com).
* > **MEDIUM:** An attacker could embed dangerous links in the instance's web UI because pull request preview links did not properly sanitize URLs. This vulnerability was reported via the [{% data variables.product.company_short %} Bug Bounty program](https://bounty.github.com).

#### Base image and package updates

Expand Down Expand Up @@ -1147,7 +1147,7 @@ A release note for a deprecation answers the following questions.

#### Examples of release notes for deprecations

* > **Upcoming deprecation**: In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell.
* > **Upcoming deprecation:** In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell.

* > Commit comments, which are comments that users add directly to a commit outside of a pull request, no longer appear in the pull request timeline. Users could not reply to or resolve these comments. The Timeline events REST API and the GraphQL API's `PullRequest` object also no longer return commit comments.
Expand Down Expand Up @@ -1175,7 +1175,7 @@ A release note for a feature that is closing down answers the following question

#### Examples of release notes for features that are closing down

* > **Closing down**: In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell.
* > **Closing down:** In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell.

* > Commit comments, which are comments that users add directly to a commit outside of a pull request, no longer appear in the pull request timeline. Users could not reply to or resolve these comments. The Timeline events REST API and the GraphQL API's `PullRequest` object also no longer return commit comments.
Expand All @@ -1201,7 +1201,7 @@ A release note for a retired feature answers the following questions.
#### Examples of release notes for retired features
* > **Retired**: {% data variables.product.github %} no longer supports required workflows for {% data variables.product.prodname_actions %} in {% data variables.product.prodname_ghe_server %} 3.11 and later. Use repository rulesets instead. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)."
* > **Retired:** {% data variables.product.github %} no longer supports required workflows for {% data variables.product.prodname_actions %} in {% data variables.product.prodname_ghe_server %} 3.11 and later. Use repository rulesets instead. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)."
{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,24 +45,24 @@ Videos are broadly grouped into three categories: product overviews, feature vid

### Product overviews

* **Purpose**: Briefly explain what the product is, showcase the main functionality, and get people interested
* **Length**: Less than a minute
* **Possible audiences**: People who want to know if a feature is useful for their goals, people who are new to {% data variables.product.company_short %} and trying to understand what the products do
* **Possible locations in the docs**: Landing pages and guides
* **Purpose:** Briefly explain what the product is, showcase the main functionality, and get people interested
* **Length:** Less than a minute
* **Possible audiences:** People who want to know if a feature is useful for their goals, people who are new to {% data variables.product.company_short %} and trying to understand what the products do
* **Possible locations in the docs:** Landing pages and guides

### Feature videos

* **Purpose**: Supplement conceptual or procedural content
* **Length**: As short as possible, without exceeding five minutes. Break longer content into multiple shorter, focused videos
* **Possible audiences**: People who are learning about or how to use a feature
* **Possible locations in the docs**: Guides, conceptual articles, procedural articles
* **Purpose:** Supplement conceptual or procedural content
* **Length:** As short as possible, without exceeding five minutes. Break longer content into multiple shorter, focused videos
* **Possible audiences:** People who are learning about or how to use a feature
* **Possible locations in the docs:** Guides, conceptual articles, procedural articles

### Tutorials

* **Purpose**: Help novice users get going with a product, drive adoption, or explain complex functionalities
* **Length**: Individual videos should be five minutes or less. Complex topics can have a series of shorter videos spread across an article. Total length should be a maximum of 15 minutes
* **Possible audiences**: New users of features or products
* **Possible locations**: Guides
* **Purpose:** Help novice users get going with a product, drive adoption, or explain complex functionalities
* **Length:** Individual videos should be five minutes or less. Complex topics can have a series of shorter videos spread across an article. Total length should be a maximum of 15 minutes
* **Possible audiences:** New users of features or products
* **Possible locations:** Guides

## When to use videos

Expand Down
Loading

0 comments on commit e5877f8

Please sign in to comment.