Skip to content

Commit

Permalink
Make images accessible in the /images root directory (github#35016)
Browse files Browse the repository at this point in the history
Co-authored-by: Sarah Edwards <[email protected]>
Co-authored-by: Isaac Brown <[email protected]>
  • Loading branch information
3 people authored Feb 27, 2023
1 parent 3ea0fb0 commit ab6d8b7
Show file tree
Hide file tree
Showing 91 changed files with 126 additions and 145 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ For each language, upload the new file to Azure blob storage in the `enterprise`

After uploading the new files, you will need to purge the Fastly cache for the single page. From Okta, go to Fastly and select `docs`. Click `Purge` then `Purge URL`. If you need to purge a whole path, just do a `Purge All`

![](/assets/images/fastly_purge.jpg)
![](/contributing/images/fastly_purge.jpg)

Enter the URL or path and do a soft purge.

![](/assets/images/fastly_purge_url.jpg)
![](/contributing/images/fastly_purge_url.jpg)
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Welcome to GitHub docs contributing guide <!-- omit in toc -->

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:.
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:.

Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
Use the table of contents icon <img src="/contributing/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.

## New contributor guide

Expand All @@ -28,7 +28,7 @@ Check to see what [types of contributions](/contributing/types-of-contributions.

#### Create a new issue

If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).

#### Solve an issue

Expand All @@ -38,9 +38,9 @@ Scan through our [existing issues](https://github.com/github/docs/issues) to fin

#### Make changes in the UI

Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.

<img src="./assets/images/contribution_cta.png" width="300" height="150" />
<img src="/contributing/images/contribution_cta.png" />

#### Make changes in a codespace

Expand All @@ -67,7 +67,7 @@ Commit the changes once you are happy with them. Don't forget to [self-review](/
### Pull Request

When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
Expand All @@ -77,9 +77,9 @@ Once you submit your PR, a Docs team member will review your proposal. We may as

### Your PR is merged!

Congratulations :tada::tada: The GitHub team thanks you :sparkles:.
Congratulations :tada::tada: The GitHub team thanks you :sparkles:.

Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en).
Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en).

Now that you are part of the GitHub docs community, see how else you can [contribute to the docs](/contributing/types-of-contributions.md).

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# GitHub Docs <!-- omit in toc -->
# GitHub Docs <!-- omit in toc -->

This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com).

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
Use the table of contents icon <img src="/contributing/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.

## Contributing

See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project.
See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project.

We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code.

On the GitHub Docs site, you can click the make a contribution button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes.

<img src="./assets/images/contribution_cta.png" width="400">
<img src="./contributing/images/contribution_cta.png" width="400">

For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see.

Expand Down
Binary file removed assets/images/actions-approve-deployments.png
Binary file not shown.
Binary file removed assets/images/actions-manually-run-workflow.png
Binary file not shown.
Binary file removed assets/images/actions-review-deployments.png
Binary file not shown.
Binary file not shown.
Binary file removed assets/images/actions-workflow-dispatch.png
Binary file not shown.
Binary file removed assets/images/add-deploy-key.png
Binary file not shown.
Binary file removed assets/images/app_id.png
Binary file not shown.
Binary file not shown.
Binary file removed assets/images/check_run_annotations.png
Binary file not shown.
Binary file removed assets/images/check_runs.png
Binary file not shown.
Binary file removed assets/images/check_suites.png
Binary file not shown.
Binary file removed assets/images/contribution_cta.png
Binary file not shown.
Binary file removed assets/images/create_app.png
Binary file not shown.
Binary file removed assets/images/deploy-key.png
Binary file not shown.
Binary file removed assets/images/electrocat.png
Binary file not shown.
Binary file removed assets/images/environments-sidebar.png
Binary file not shown.
Binary file removed assets/images/git-database-overview.png
Binary file not shown.
Binary file removed assets/images/gundamcat.png
Binary file not shown.
File renamed without changes
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.
File renamed without changes
File renamed without changes
Binary file added assets/images/help/apps/identicon.png
File renamed without changes
File renamed without changes
Binary file removed assets/images/homepage-url.png
Diff not rendered.
Binary file removed assets/images/identicon.png
Diff not rendered.
Binary file removed assets/images/install_permissions.png
Diff not rendered.
Binary file removed assets/images/intro-to-apps-flow.png
Diff not rendered.
Binary file removed assets/images/new-app.png
Diff not rendered.
Binary file removed assets/images/oauth_prompt.png
Diff not rendered.
Binary file removed assets/images/payload_request_tab.png
Diff not rendered.
Binary file removed assets/images/payload_response_tab.png
Diff not rendered.
Binary file removed assets/images/private_key.png
Diff not rendered.
Binary file removed assets/images/profile-page.png
Diff not rendered.
Binary file removed assets/images/repo-settings.png
Diff not rendered.
Binary file removed assets/images/repos.png
Diff not rendered.
Binary file removed assets/images/sinatra-404.png
Diff not rendered.
Binary file removed assets/images/smee-new-channel.png
Diff not rendered.
Binary file removed assets/images/smee-unique-domain.png
Diff not rendered.
Binary file removed assets/images/text-match-search-api.png
Diff not rendered.
Binary file removed assets/images/webhook-secret.png
Diff not rendered.
Binary file removed assets/images/webhook-url.png
Diff not rendered.
Binary file removed assets/images/webhook_sample_url.png
Diff not rendered.
Binary file removed assets/images/webhook_secret_token.png
Diff not rendered.
Binary file removed assets/images/webhooks_recent_deliveries.png
Diff not rendered.
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ We recommend auditing and unsubscribing from your subscriptions as a part of a h
When your inbox has too many notifications to manage, consider whether you have oversubscribed or how you can change your notification settings to reduce the subscriptions you have and the types of notifications you're receiving. For example, you may consider disabling the settings to automatically watch all repositories and all team discussions whenever you've joined a team or repository.

{% ifversion update-notification-settings-22 %}
![Screenshot of automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png)
![Screenshot of the toggles for "Automatically watch repositories" and "Automatically watch teams".](/assets/images/help/notifications-v2/automatically-watch-repos-and-teams.png)
{% else %}
![Screenshot of automatic watching options for teams and repositories](/assets/images/help/notifications-v2/automatic-watching-example.png){% endif %}

For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#automatic-watching)."

To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)."
To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)."
{% tip %}

**Tip:** You can select the types of event to be notified of by using the **Custom** option of the **Watch/Unwatch** dropdown list in your [watching page](https://github.com/watching) or on any repository page on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)."
Expand Down 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 when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options, 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.

{% endtip %}
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Email notifications from {% data variables.location.product_location %} contain
By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options in your notification settings.

{% ifversion update-notification-settings-22 %}
![Automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png)
![Screenshot of the toggles for "Automatically watch repositories" and "Automatically watch teams".](/assets/images/help/notifications-v2/automatically-watch-repos-and-teams.png)
{% else %}
![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png){% endif %}

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

You can deliver deployments through {% data variables.product.prodname_actions %} and environments or with the REST API and third party apps. For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about deployments with the REST API, see "[AUTOTITLE](/rest/repos#deployments)."

To view current and past deployments, click **Environments** on the home page of your repository.
{% ifversion ghae %}
![Environments](/assets/images/enterprise/2.22/environments-sidebar.png){% else %}
![Environments](/assets/images/environments-sidebar.png){% endif %}
To view current and past deployments, click **Environments** in the sidebar of the home page of your repository.

![Screenshot of the sidebar of a repository page. The "Environments" section is outlined in dark orange.](/assets/images/help/actions/environments-sidebar.png)

The deployments page displays the last active deployment of each environment for your repository. If the deployment includes an environment URL, a **View deployment** button that links to the URL is shown next to the deployment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ To run a workflow manually, the workflow must be configured to run on the `workf
![Screenshot of the "Actions" page. Features apart from one workflow in the left sidebar are grayed out.](/assets/images/help/repository/actions-select-workflow.png)
{%- endif %}
1. Above the list of workflow runs, select **Run workflow**.
![actions workflow dispatch](/assets/images/actions-workflow-dispatch.png)
1. Use the **Branch** dropdown to select the workflow's branch, and type the input parameters. Click **Run workflow**.
![actions manually run workflow](/assets/images/actions-manually-run-workflow.png)

![Screenshot of a workflow page. Above the list of workflow runs, a button, labeled "Run workflow", is outlined in dark orange.](/assets/images/help/actions/actions-workflow-dispatch.png)
1. Select the **Branch** dropdown menu and click a branch to run the workflow on.
1. If the workflow requires input, fill in the fields.
1. Click **Run workflow**.

{% endwebui %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,8 @@ For more information about environments and required approvals, see "[AUTOTITLE]
## Approving or rejecting a job

1. Navigate to the workflow run that requires review. For more information about navigating to a workflow run, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."
2. Click **Review deployments**.
![Review deployments](/assets/images/actions-review-deployments.png)
2. If the run requires review, you will see a notification for the review request. On the notification, click **Review deployments**.
3. Select the job environment(s) to approve or reject. Optionally, leave a comment.
![Approve deployments](/assets/images/actions-approve-deployments.png)
4. Approve or reject:
- To approve the job, click **Approve and deploy**. Once a job is approved (and any other environment protection rules have passed), the job will proceed. At this point, the job can access any secrets stored in the environment.
- To reject the job, click **Reject**. If a job is rejected, the workflow will fail.
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ The software tools included in {% data variables.product.prodname_dotcom %}-host
### Preinstalled software

Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Runner Image` section. The link following `Included Software` will describe the preinstalled tools on the runner that ran the workflow.
![Installed software link](/assets/images/actions-runner-installed-software-link.png)

For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."

For the overall list of included tools for each runner operating system, see the links below:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,17 @@ The {% data variables.actions.hosted_runner %}s are managed at the organization

In the following diagram, a class of hosted runner named `ubuntu-20.04-16core` has been defined with customized hardware and operating system configuration.

![Diagram explaining {% data variables.actions.hosted_runner %}](/assets/images/hosted-runner.png)
![Diagram showing a larger runner being used by a workflow because of the runner's label.](/assets/images/help/actions/hosted-runner.png)

1. Instances of this runner are automatically created and added to a group called `grp-ubuntu-20.04-16core`.
2. The runners have been assigned the label `ubuntu-20.04-16core`.
1. Instances of this runner are automatically created and added to a group called `grp-ubuntu-20.04-16core`.
2. The runners have been assigned the label `ubuntu-20.04-16core`.
3. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job.
4. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner.
5. The job runs on the next available instance of the `ubuntu-20.04-16core` runner.

## Autoscaling {% data variables.actions.hosted_runner %}s

Your {% data variables.actions.hosted_runner %}s can be configured to automatically scale to suit your needs. When jobs are submitted for processing, more machines can be automatically provisioned to run the jobs, until reaching a pre-defined maximum limit. Each machine only handles one job at a time, so these settings effectively determine the number of jobs that can be run concurrently.
Your {% data variables.actions.hosted_runner %}s can be configured to automatically scale to suit your needs. When jobs are submitted for processing, more machines can be automatically provisioned to run the jobs, until reaching a pre-defined maximum limit. Each machine only handles one job at a time, so these settings effectively determine the number of jobs that can be run concurrently.

During the runner deployment process, you can configure the _Max_ option, which allows you to control your costs by setting the maximum parallel number of machines that are created in this set. A higher value here can help avoid workflows being blocked due to parallelism.

Expand Down Expand Up @@ -94,7 +94,7 @@ You can add {% data variables.actions.hosted_runner %}s to an enterprise, where

## Adding a {% data variables.actions.hosted_runner %} to an organization

You can add a {% data variables.actions.hosted_runner %} to an organization, where the organization admins can control which repositories can use it.
You can add a {% data variables.actions.hosted_runner %} to an organization, where the organization admins can control which repositories can use it.

{% data reusables.actions.add-hosted-runner-overview %}

Expand Down Expand Up @@ -159,9 +159,9 @@ Runner groups are used to control which repositories can run jobs on your {% dat
- **Runners at the enterprise level**: Configure the runner group to grant access to all the required organizations. In addition, for each organization, you must configure the group to specify which repositories are allowed access.
- **Runners at the organization level**: Configure the runner group by specifying which repositories are allowed access.
For example, the following diagram has a runner group named `grp-ubuntu-20.04-16core` at the enterprise level. Before the repository named `octo-repo` can use the runners in the group, you must first configure the group at the enterprise level to allow access from the `octo-org` organization; you must then configure the group at the organization level to allow access from `octo-repo`:
For example, the following diagram has a runner group named `grp-ubuntu-20.04-16core` at the enterprise level. Before the repository named `octo-repo` can use the runners in the group, you must first configure the group at the enterprise level to allow access from the `octo-org` organization. You must then configure the group at the organization level to allow access from `octo-repo`.

![Diagram explaining {% data variables.actions.hosted_runner %} groups](/assets/images/hosted-runner-mgmt.png)
![Diagram that shows a lock between a runner group at the enterprise level and an organization, and between the organization and two repositories owned by the organization.](/assets/images/help/actions/hosted-runner-mgmt.png)

### Allowing repositories to access a runner group

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ jobs:

{% endpowershell %}

![Foldable group in workflow run log](/assets/images/actions-log-group.png)
![Screenshot of the log for the workflow step. The second line, "My title", is prefaced by a downward arrow, indicating an expanded group. The next line, "Inside group", is indented below.](/assets/images/help/actions/actions-log-group.png)

## Masking a value in log

Expand Down Expand Up @@ -832,7 +832,7 @@ echo "### Hello world! :rocket:" >> $GITHUB_STEP_SUMMARY

{% endpowershell %}

![Markdown summary example](/assets/images/actions-job-summary-simple-example.png)
![Screenshot of the summary page of a workflow run. Under "example summary" is "Hello world!" and a rocket emoji.](/assets/images/help/actions/actions-job-summary-simple-example.png)

### Multiline Markdown content

Expand Down
Loading

0 comments on commit ab6d8b7

Please sign in to comment.