Skip to content

Commit

Permalink
website: Adds content-check command and README update (#1149)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bryce Kalow authored Feb 14, 2023
1 parent 895fb9d commit d646588
Show file tree
Hide file tree
Showing 3 changed files with 2,740 additions and 2 deletions.
12 changes: 11 additions & 1 deletion website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,21 @@ To preview your content, complete the following steps:
1. Open `http://localhost:3000` in your web browser. While the preview is running, you can edit pages and Next.js will automatically rebuild them.
1. When you're done with the preview, press `ctrl-C` in your terminal to stop the server.

### Validating Content

Content changes are automatically validated against a set of rules as part of the pull request process. If you want to run these checks locally to validate your content before committing your changes, you can run the following command:

```
npm run content-check
```

If the validation fails, actionable error messages will be displayed to help you address detected issues.

## Deployment

The website reads content from release tags to generate documentation for all versions of `terraform-plugin-sdk` documentation. Changes merged into `main` will be included in the documentation for the next product release.

You cannot edit documentation for past versions of `terraform-plugin-sdk` on the site. Documentation is an artifact of a product release. We push docs fixes forward for the next release, rather than retroactively fixing older versions.

[nav-data]: ../website/data/plugin-sdk-nav-data.json
[terraform.io]: https://www.terraform.io/
[terraform.io]: https://www.terraform.io/
Loading

0 comments on commit d646588

Please sign in to comment.