Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo sync #29690

Merged
merged 1 commit into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ gh actions-importer list-features

You should see an output similar to the following.

<!-- markdownlint-disable search-replace -->

```shell
Available feature flags:

Expand All @@ -131,6 +133,8 @@ Enable features by passing --enable-features feature-1 feature-2
Disable features by passing --disable-features feature-1 feature-2
```

<!-- markdownlint-enable search-replace -->

To toggle feature flags, you can use either of the following methods:
- Use the `--enable-features` and `--disable-features` options when running a `gh actions-importer` command.
- Use an environment variable for each feature flag.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ topics:
- CD
shortTitle: Migrate from CircleCI
---

{% data reusables.actions.enterprise-github-hosted-runners %}

## Introduction
Expand Down Expand Up @@ -227,6 +227,8 @@ workflows:

### GitHub Actions syntax for using databases and service containers

<!-- markdownlint-disable search-replace -->

```yaml
name: Containers

Expand Down Expand Up @@ -272,6 +274,8 @@ jobs:
run: bundle exec rake
```

<!-- markdownlint-enable search-replace -->

For more information, see "[AUTOTITLE](/actions/using-containerized-services/about-service-containers)."

## Complete Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ Notice that all of the examples use a short version number for the action (`v3`)

This {% data variables.dependency-review.action_name %} example file illustrates how you can use the available configuration options.

<!-- markdownlint-disable search-replace -->

```yaml copy
name: 'Dependency Review'
on: [pull_request]
Expand All @@ -133,7 +135,7 @@ Notice that all of the examples use a short version number for the action (`v3`)
- name: Dependency Review
uses: actions/dependency-review-action@v3
with:
# Possible values: "critical", "high", "moderate", "low"
# Possible values: "critical", "high", "moderate", "low"
fail-on-severity: critical

{% ifversion dependency-review-action-licenses %}
Expand All @@ -155,6 +157,8 @@ Notice that all of the examples use a short version number for the action (`v3`)
{% endif %}
```

<!-- markdownlint-enable search-replace -->

### Using a configuration file to set up {% data variables.dependency-review.action_name %}

1. Add a new YAML workflow to your `.github/workflows` folder and use `config-file` to specify that you are using a configuration file.
Expand All @@ -180,19 +184,21 @@ Notice that all of the examples use a short version number for the action (`v3`)
with:
# ([String]). Representing a path to a configuration file local to the repository or in an external repository.
# Possible values: An absolute path to a local file or an external file.
config-file: './.github/dependency-review-config.yml'
config-file: './.github/dependency-review-config.yml'
# Syntax for an external file: OWNER/REPOSITORY/FILENAME@BRANCH
config-file: 'github/octorepo/dependency-review-config.yml@main'

# ([Token]) Use if your configuration file resides in a private external repository.
# Possible values: Any GitHub token with read access to the private external repository.
# Possible values: Any GitHub token with read access to the private external repository.
external-repo-token: 'ghp_123456789abcde'
```

1. Create the configuration file in the path you have specified.

This YAML example file illustrates how you can use the available configuration options.

<!-- markdownlint-disable search-replace -->

```yaml copy
# Possible values: "critical", "high", "moderate", "low"
fail-on-severity: critical
Expand Down Expand Up @@ -224,5 +230,7 @@ Notice that all of the examples use a short version number for the action (`v3`)
{% endif %}
```

<!-- markdownlint-enable search-replace -->

For further details about the configuration options, see [`dependency-review-action`](https://github.com/actions/dependency-review-action#readme).
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ versions:

{% data variables.product.prodname_dotcom %} documentation is open source. Anyone can contribute to the docs in the public `docs` repository: https://github.com/github/docs. {% data variables.product.prodname_dotcom %} employees work on the documentation in a copy of this repository called `docs-internal`. The two repositories are automatically synced to keep them both up to date with changes merged into the `main` branch of either repository. For simplicity, we'll refer to "the documentation repository" in the articles about contributing to {% data variables.product.prodname_docs %}.

The documentation repository is the place to discuss and collaborate on the documentation that is published here on [docs.github.com](/).
The documentation repository is the place to discuss and collaborate on the documentation that is published here on [docs.github.com](/).<!-- markdownlint-disable-line search-replace -->

{% ifversion discussions %}

Expand All @@ -31,7 +31,7 @@ If you'd like help troubleshooting a documentation issue or pull request you're

[Issues](/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with. If an issue has a `triage` label, we haven't reviewed it yet, and you shouldn't begin work on it.

If you've found something in the documentation content, or something about the docs.github.com website, that should be updated, search the open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you'd like to be fixed.
If you've found something in the documentation content, or something about the docs.github.com website, that should be updated, search the open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you'd like to be fixed.<!-- markdownlint-disable-line search-replace -->

{% note %}

Expand Down Expand Up @@ -75,6 +75,6 @@ We do not currently accept pull requests for translated content.

## Site policy

{% data variables.product.prodname_dotcom %}'s site policies are also published on docs.github.com.
{% data variables.product.prodname_dotcom %}'s site policies are also published on docs.github.com.<!-- markdownlint-disable-line search-replace -->

If you find a typo in the site policy section, you can open a pull request to fix it. For anything else, see "[Contributing](https://github.com/github/site-policy/blob/main/CONTRIBUTING.md)" in the `site-policy` repository.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ You can use labels to locate a particular type of issue. For example, click the
| --- | --- |
| [`help wanted`](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | Problems or updates that anyone in the community can start working on. |
| [`good first issue`](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | Problems or updates we think are ideal for beginners. |
| [`content`](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Acontent) | Problems or updates in the content on docs.github.com. These will usually require some knowledge of Markdown. |
| [`engineering`](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Aengineering) | Problems or updates involving the functionality of the docs.github.com website. Fixing these issues will usually require some knowledge of JavaScript/Node.js or YAML. |
| [`content`](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Acontent) | Problems or updates in the content on docs.github.com. These will usually require some knowledge of Markdown. | <!-- markdownlint-disable-line search-replace -->
| [`engineering`](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Aengineering) | Problems or updates involving the functionality of the docs.github.com website. Fixing these issues will usually require some knowledge of JavaScript/Node.js or YAML. |<!-- markdownlint-disable-line search-replace -->
| [`codespaces`](https://github.com/github/docs/labels/codespaces)<br> [`desktop`](https://github.com/github/docs/labels/desktop)<br> [`graphql`](https://github.com/github/docs/labels/graphql) | Labels for filtering issues by a product or documentation area. |
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following steps assume you have {% data variables.product.prodname_github_co
The "Setting up your codespace" page is displayed. After a short time the browser-based version of {% data variables.product.prodname_vscode %} is displayed.
1. Use the Explorer to navigate to the markdown file you want to edit. If the file is an article, it will be located in the `content` directory. If the file is reusable content, it will be located in the `data` directory.

In most cases, the path to an article in the `content` directory matches the path in the URL, minus the `.md` file extension. For example, the source for the article `https://docs.github.com/en/codespaces/getting-started/quickstart` is the markdown file `content/codespaces/getting-started/quickstart.md`.
In most cases, the path to an article in the `content` directory matches the path in the URL, minus the `.md` file extension. For example, the source for the article `https://docs.github.com/en/codespaces/getting-started/quickstart` is the markdown file `content/codespaces/getting-started/quickstart.md`.<!-- markdownlint-disable-line search-replace -->
1. Edit the markdown file as required.
1. Save your changes.
1. Commit and push your changes, either using the Source Control view, or using Git commands from the Terminal. For more information, see "[AUTOTITLE](/get-started/using-git/about-git)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Docs are organized into multiple levels of hierarchy on our site.

## Homepage content

The {% data variables.product.prodname_docs %} homepage, [docs.github.com](/), highlights the most important topics that people want to find. We limit the number of doc sets on the homepage so that people can find information and the homepage does not become overcrowded and difficult to search.
The {% data variables.product.prodname_docs %} homepage, [docs.github.com](/), highlights the most important topics that people want to find. We limit the number of doc sets on the homepage so that people can find information and the homepage does not become overcrowded and difficult to search.<!-- markdownlint-disable-line search-replace -->

The homepage includes all top-level doc sets and some categories. Content on the homepage is organized around {% data variables.product.prodname_dotcom %} concepts and practices. For example, the "CI/CD and DevOps" group includes top-level doc sets for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %}, and {% data variables.product.prodname_pages %}.

Expand Down Expand Up @@ -71,7 +71,7 @@ Categories are organized around a feature or a discrete set of tasks within a to
- Examples
- [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github)
- [AUTOTITLE](/pull-requests/committing-changes-to-your-project)

### Intros for categories

All categories have intros. Intros should be one sentence long and general or high-level enough to scale with future product changes. If you significantly change a category’s structure, check its intro for needed updates.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Contents of quickstarts:
- If relevant troubleshooting content exists for the quickstart, provide links to it.
- Next steps
- Provide a quick recap of what has been accomplished in the quickstart as a means of transitioning to next steps.
- Include 2-3 actionable next steps that someone can take after completing the quickstart. Always link to conceptual content on the feature or product. You can also link off to other related information on docs.github.com or in {% data variables.product.prodname_learning %}.
- Include 2-3 actionable next steps that someone can take after completing the quickstart. Always link to conceptual content on the feature or product. You can also link off to other related information on docs.github.com or in {% data variables.product.prodname_learning %}.<!-- markdownlint-disable-line search-replace -->

## Title guidelines for quickstarts

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:

{% note %}

**Note:** These guidelines are specific to {% data variables.product.company_short %}'s documentation. For general style questions or guidance on topics not covered here, see the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs)." For any questions about the GitHub brand, see our "[GitHub Brand Guide](https://brand.github.com)."<!-- markdownlint-disable-line -->
**Note:** These guidelines are specific to {% data variables.product.company_short %}'s documentation. For general style questions or guidance on topics not covered here, see the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs)." For any questions about the GitHub brand, see our "[GitHub Brand Guide](https://brand.github.com)."<!-- markdownlint-disable-line search-replace -->

{% endnote %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Contents of tutorials:
- Next steps
- Include 2-3 actionable next steps that someone can take after completing the tutorial. Link off to other related information like:
- Projects on {% data variables.product.prodname_dotcom %} that illustrate the introduced concepts
- Relevant information on docs.github.com
- Relevant information on docs.github.com<!-- markdownlint-disable-line search-replace -->
- Relevant {% data variables.product.prodname_learning %}
- Relevant published talks, blog posts, or Community Forum series posts by Hubbers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ See [`redirect_from`](https://github.com/github/docs/blob/main/content/README.md

### Automatic redirects for URLs that do not include a version

If a URL for a page is entered without a version (`https://docs.github.com/ARTICLE` instead of `https://docs.github.com/VERSION/ARTICLE`), the site will automatically redirect it to the first available version of the page.
If a URL for a page is entered without a version (`https://docs.github.com/ARTICLE` instead of `https://docs.github.com/VERSION/ARTICLE`), the site will automatically redirect it to the first available version of the page.<!-- markdownlint-disable-line search-replace -->

The order of precedence is specified in [`lib/all-versions.js`](https://github.com/github/docs/blob/main/src/versions/lib/all-versions.js). The current order of precedence is:

Expand All @@ -43,9 +43,9 @@ The order of precedence is specified in [`lib/all-versions.js`](https://github.c
1. {% data variables.product.prodname_ghe_server %} (`ghes`)
1. {% data variables.product.prodname_ghe_managed %} (`ghae`)

If a page titled `ARTICLE` is only available in {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}, the link `https://docs.github.com/ARTICLE` will automatically redirect to `https://docs.github.com/enterprise-cloud@latest/ARTICLE` because {% data variables.product.prodname_ghe_cloud %} has precedence over {% data variables.product.prodname_ghe_server %}.
If a page titled `ARTICLE` is only available in {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}, the link `https://docs.github.com/ARTICLE` will automatically redirect to `https://docs.github.com/enterprise-cloud@latest/ARTICLE` because {% data variables.product.prodname_ghe_cloud %} has precedence over {% data variables.product.prodname_ghe_server %}.<!-- markdownlint-disable-line search-replace -->

If `ARTICLE` is available in Free, Pro, or Team, no redirect will occur because `fpt` pages do not have a version segment, so the `fpt` content at `https://docs.github.com/ARTICLE` will render.
If `ARTICLE` is available in Free, Pro, or Team, no redirect will occur because `fpt` pages do not have a version segment, so the `fpt` content at `https://docs.github.com/ARTICLE` will render.<!-- markdownlint-disable-line search-replace -->

### Redirects across versions

Expand Down
Loading
Loading