Skip to content

Commit

Permalink
Merge pull request #83 from sjokkateer/docs/github-actions-readme
Browse files Browse the repository at this point in the history
[Fix] README: Small typo & markdown
  • Loading branch information
froschdesign authored Jun 27, 2022
2 parents 9084407 + a533ae1 commit 0d9c7fa
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions github-actions/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ As an example:
siteUrl: https://docs.laminas.dev
```
The above will build docs in the `doc/html` subdirectory, will NOT build for
The above will build docs in the `docs/html` subdirectory, will NOT build for
empty commits, and uses an alternate base site URL.

## Behaviors
Expand Down Expand Up @@ -51,7 +51,7 @@ empty commits, and uses an alternate base site URL.

## Environment

This action requires on of either the environment variable `$DEPLOY_TOKEN` or `$DOCS_DEPLOY_KEY`:
This action requires one of either the environment variable `$DEPLOY_TOKEN` or `$DOCS_DEPLOY_KEY`:

- **$DEPLOY_TOKEN** (preferred) should be a GitHub OAuth token with permissions to commit code.
(In the Laminas and Mezzio organizations, we store this as the `ORGANIZATION_ADMIN_TOKEN` secret at the organization level.)
Expand Down Expand Up @@ -117,7 +117,7 @@ jobs:
emptyCommits: false
```

2. If your repository has not yet updated to use release branches and/or [automatic-releases](https://github.com/laminas/automatic-releases], and you are still using the "master" branch to reflect current stable, you may also use the following workflow:
2. If your repository has not yet updated to use release branches and/or [automatic-releases](https://github.com/laminas/automatic-releases), and you are still using the "master" branch to reflect current stable, you may also use the following workflow:

```yaml
name: docs-build
Expand Down

0 comments on commit 0d9c7fa

Please sign in to comment.