Skip to content

Commit 4545543

Browse files
graceparkjhosman
andauthored
Fix for md049 consistent emphasis (#38201)
Co-authored-by: Jess Hosman <1183847+jhosman@users.noreply.github.com>
1 parent 638de9b commit 4545543

File tree

224 files changed

+670
-670
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

224 files changed

+670
-670
lines changed

content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Your contributions calendar shows your contribution activity.
6060
### Viewing contributions from specific times
6161

6262
- Click on a day's square to show the contributions made during that 24-hour period.
63-
- Press *Shift* and click on another day's square to show contributions made during that time span.
63+
- Press _Shift_ and click on another day's square to show contributions made during that time span.
6464

6565
{% note %}
6666

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ shortTitle: Marketing emails
2424

2525
{% data reusables.user-settings.access_settings %}
2626
{% data reusables.user-settings.emails %}
27-
3. Under *Email preferences*, select **Only receive account related emails, and those I subscribe to**.
27+
3. Under _Email preferences_, select **Only receive account related emails, and those I subscribe to**.
2828
4. Click **Save email preferences**.
2929

3030
## Further reading

content/actions/automating-builds-and-tests/building-and-testing-nodejs.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ If you don't specify a Node.js version, {% data variables.product.prodname_dotco
137137

138138
### Example using npm
139139

140-
This example installs the dependencies defined in the *package.json* file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install).
140+
This example installs the dependencies defined in the _package.json_ file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install).
141141

142142
```yaml copy
143143
steps:
@@ -150,7 +150,7 @@ steps:
150150
run: npm install
151151
```
152152

153-
Using `npm ci` installs the versions in the *package-lock.json* or *npm-shrinkwrap.json* file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)."
153+
Using `npm ci` installs the versions in the _package-lock.json_ or _npm-shrinkwrap.json_ file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)."
154154

155155
```yaml copy
156156
steps:
@@ -165,7 +165,7 @@ steps:
165165

166166
### Example using Yarn
167167

168-
This example installs the dependencies defined in the *package.json* file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install).
168+
This example installs the dependencies defined in the _package.json_ file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install).
169169

170170
```yaml copy
171171
steps:
@@ -197,9 +197,9 @@ steps:
197197

198198
To authenticate to your private registry, you'll need to store your npm authentication token as a secret. For example, create a repository secret called `NPM_TOKEN`. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)."
199199

200-
In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the *.npmrc* file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an *.npmrc* file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token.
200+
In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the _.npmrc_ file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an _.npmrc_ file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token.
201201

202-
Before installing dependencies, use the `setup-node` action to create the *.npmrc* file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope).
202+
Before installing dependencies, use the `setup-node` action to create the _.npmrc_ file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope).
203203

204204
```yaml copy
205205
steps:
@@ -217,7 +217,7 @@ steps:
217217
NODE_AUTH_TOKEN: {% raw %}${{ secrets.NPM_TOKEN }}{% endraw %}
218218
```
219219

220-
The example above creates an *.npmrc* file with the following contents:
220+
The example above creates an _.npmrc_ file with the following contents:
221221

222222
```ini
223223
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
@@ -283,7 +283,7 @@ If you have a custom requirement or need finer controls for caching, you can use
283283

284284
## Building and testing your code
285285

286-
You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your *package.json* file and `npm test` to run your test suite, you would add those commands in your workflow file.
286+
You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your _package.json_ file and `npm test` to run your test suite, you would add those commands in your workflow file.
287287

288288
```yaml copy
289289
steps:

content/actions/automating-builds-and-tests/building-and-testing-python.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ steps:
213213

214214
### Requirements file
215215

216-
After you update `pip`, a typical next step is to install dependencies from *requirements.txt*. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file).
216+
After you update `pip`, a typical next step is to install dependencies from _requirements.txt_. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file).
217217

218218
```yaml copy
219219
steps:

content/actions/creating-actions/dockerfile-support-for-github-actions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ ENTRYPOINT ["sh", "-c", "echo $GITHUB_SHA"]
6262

6363
To supply `args` defined in the action's metadata file to a Docker container that uses the _exec_ form in the `ENTRYPOINT`, we recommend creating a shell script called `entrypoint.sh` that you call from the `ENTRYPOINT` instruction:
6464

65-
#### Example *Dockerfile*
65+
#### Example _Dockerfile_
6666

6767
```dockerfile
6868
# Container image that runs your code
@@ -75,7 +75,7 @@ COPY entrypoint.sh /entrypoint.sh
7575
ENTRYPOINT ["/entrypoint.sh"]
7676
```
7777

78-
#### Example *entrypoint.sh* file
78+
#### Example _entrypoint.sh_ file
7979

8080
Using the example Dockerfile above, {% data variables.product.product_name %} will send the `args` configured in the action's metadata file as arguments to `entrypoint.sh`. Add the `#!/bin/sh` [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) at the top of the `entrypoint.sh` file to explicitly use the system's [POSIX](https://en.wikipedia.org/wiki/POSIX)-compliant shell.
8181

content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,13 @@ export GITHUB_ACTIONS_RUNNER_TLS_NO_VERIFY=1
100100

101101
## Reviewing the self-hosted runner application log files
102102

103-
You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory where you installed the runner application, and a new log is generated each time the application is started. The filename begins with *Runner_*, and is followed by a UTC timestamp of when the application was started.
103+
You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory where you installed the runner application, and a new log is generated each time the application is started. The filename begins with _Runner__, and is followed by a UTC timestamp of when the application was started.
104104

105-
For detailed logs on workflow job executions, see the next section describing the *Worker_* files.
105+
For detailed logs on workflow job executions, see the next section describing the _Worker__ files.
106106

107107
## Reviewing a job's log file
108108

109-
The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory where you installed the runner application, and the filename begins with *Worker_*.
109+
The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory where you installed the runner application, and the filename begins with _Worker__.
110110

111111
{% linux %}
112112

@@ -220,7 +220,7 @@ PS C:\actions-runner> Get-EventLog -LogName Application -Source ActionsRunnerSer
220220

221221
We recommend that you regularly check the automatic update process, as the self-hosted runner will not be able to process jobs if it falls below a certain version threshold. The self-hosted runner application automatically updates itself, but note that this process does not include any updates to the operating system or other software; you will need to separately manage these updates.
222222

223-
You can view the update activities in the *Runner_* log files. For example:
223+
You can view the update activities in the _Runner__ log files. For example:
224224

225225
```shell
226226
[Feb 12 12:37:07 INFO SelfUpdater] An update is available.

content/actions/migrating-to-github-actions/manual-migrations/migrating-from-circleci-to-github-actions.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ For more information, see "[AUTOTITLE](/actions/learn-github-actions/understandi
3636
When migrating from CircleCI, consider the following differences:
3737

3838
- CircleCI’s automatic test parallelism automatically groups tests according to user-specified rules or historical timing information. This functionality is not built into {% data variables.product.prodname_actions %}.
39-
- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your *Dockerfile*. {% ifversion ghae %}{% data reusables.actions.self-hosted-runners-software %}
39+
- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your _Dockerfile_. {% ifversion ghae %}{% data reusables.actions.self-hosted-runners-software %}
4040
{% else %}For more information about the Docker filesystem on {% data variables.product.product_name %}-hosted runners, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#docker-container-filesystem)."
4141
{% endif %}
4242

4343
## Migrating workflows and jobs
4444

45-
CircleCI defines `workflows` in the *config.yml* file, which allows you to configure more than one workflow. {% data variables.product.product_name %} requires one workflow file per workflow, and as a consequence, does not require you to declare `workflows`. You'll need to create a new workflow file for each workflow configured in *config.yml*.
45+
CircleCI defines `workflows` in the _config.yml_ file, which allows you to configure more than one workflow. {% data variables.product.product_name %} requires one workflow file per workflow, and as a consequence, does not require you to declare `workflows`. You'll need to create a new workflow file for each workflow configured in _config.yml_.
4646

4747
Both CircleCI and {% data variables.product.prodname_actions %} configure `jobs` in the configuration file using similar syntax. If you configure any dependencies between jobs using `requires` in your CircleCI workflow, you can use the equivalent {% data variables.product.prodname_actions %} `needs` syntax. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idneeds)."
4848

@@ -162,7 +162,7 @@ For more information, see "[AUTOTITLE](/actions/using-workflows/storing-workflow
162162
163163
Both systems enable you to include additional containers for databases, caching, or other dependencies.
164164
165-
In CircleCI, the first image listed in the *config.yaml* is the primary image used to run commands. {% data variables.product.prodname_actions %} uses explicit sections: use `container` for the primary container, and list additional containers in `services`.
165+
In CircleCI, the first image listed in the _config.yaml_ is the primary image used to run commands. {% data variables.product.prodname_actions %} uses explicit sections: use `container` for the primary container, and list additional containers in `services`.
166166

167167
Below is an example in CircleCI and {% data variables.product.prodname_actions %} configuration syntax.
168168

@@ -274,7 +274,7 @@ For more information, see "[AUTOTITLE](/actions/using-containerized-services/abo
274274

275275
## Complete Example
276276

277-
Below is a real-world example. The left shows the actual CircleCI *config.yml* for the [thoughtbot/administrator](https://github.com/thoughtbot/administrate) repository. The right shows the {% data variables.product.prodname_actions %} equivalent.
277+
Below is a real-world example. The left shows the actual CircleCI _config.yml_ for the [thoughtbot/administrator](https://github.com/thoughtbot/administrate) repository. The right shows the {% data variables.product.prodname_actions %} equivalent.
278278

279279
### Complete example for CircleCI
280280

0 commit comments

Comments
 (0)