From 72497fefbed8b36b4d1e219906d92493feda5814 Mon Sep 17 00:00:00 2001 From: Bryce Kalow Date: Mon, 24 Apr 2023 15:36:39 -0500 Subject: [PATCH] chore: update casing for some words (#204) --- .changeset/loud-moles-do.md | 5 +++++ packages/cli/markdown-blocks/deployment.md | 2 +- packages/cli/markdown-blocks/editing-markdown.md | 4 ++-- packages/cli/markdown-blocks/local-development.md | 4 ++-- 4 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 .changeset/loud-moles-do.md diff --git a/.changeset/loud-moles-do.md b/.changeset/loud-moles-do.md new file mode 100644 index 00000000..d09cb0d7 --- /dev/null +++ b/.changeset/loud-moles-do.md @@ -0,0 +1,5 @@ +--- +'@hashicorp/platform-cli': patch +--- + +Update casing for some words in markdown blocks. diff --git a/packages/cli/markdown-blocks/deployment.md b/packages/cli/markdown-blocks/deployment.md index 2b698052..bd5b6a4f 100644 --- a/packages/cli/markdown-blocks/deployment.md +++ b/packages/cli/markdown-blocks/deployment.md @@ -1,3 +1,3 @@ ## Deployment -This website is hosted on Vercel and configured to automatically deploy anytime you push code to the `stable-website` branch. Any time a pull request is submitted that changes files within the `website` folder, a deployment preview will appear in the github checks which can be used to validate the way docs changes will look live. Deployments from `stable-website` will look and behave the same way as deployment previews. +This website is hosted on Vercel and configured to automatically deploy anytime you push code to the `stable-website` branch. Any time a pull request is submitted that changes files within the `website` folder, a deployment preview will appear in the GitHub checks which can be used to validate the way docs changes will look live. Deployments from `stable-website` will look and behave the same way as deployment previews. diff --git a/packages/cli/markdown-blocks/editing-markdown.md b/packages/cli/markdown-blocks/editing-markdown.md index 3e7eb700..f32fd678 100644 --- a/packages/cli/markdown-blocks/editing-markdown.md +++ b/packages/cli/markdown-blocks/editing-markdown.md @@ -24,7 +24,7 @@ The significant keys in the YAML frontmatter are: ### 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 comitting your changes, you can run the following command: +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 @@ -38,7 +38,7 @@ There is currently a small bug with new page creation - if you create a new page ### Markdown Enhancements -There are several custom markdown plugins that are available by default that enhance [standard markdown](https://commonmark.org/) to fit our use cases. This set of plugins introduces a couple instances of custom syntax, and a couple specific pitfalls that are not present by default with markdown, detailed below: +There are several custom Markdown plugins that are available by default that enhance [standard markdown](https://commonmark.org/) to fit our use cases. This set of plugins introduces a couple instances of custom syntax, and a couple specific pitfalls that are not present by default with markdown, detailed below: - > **Warning**: We are deprecating the current [paragraph alerts](https://github.com/hashicorp/remark-plugins/tree/master/plugins/paragraph-custom-alerts#paragraph-custom-alerts), in favor of the newer [MDX Inline Alert](#inline-alerts) components. The legacy paragraph alerts are represented by the symbols `~>`, `->`, `=>`, or `!>`. - If you see `@include '/some/path.mdx'`, this is a [markdown include](https://github.com/hashicorp/remark-plugins/tree/master/plugins/include-markdown#include-markdown-plugin). It's worth noting as well that all includes resolve from `website/content/partials` by default, and that changes to partials will not live-reload the website. diff --git a/packages/cli/markdown-blocks/local-development.md b/packages/cli/markdown-blocks/local-development.md index e351f88b..1a6dce73 100644 --- a/packages/cli/markdown-blocks/local-development.md +++ b/packages/cli/markdown-blocks/local-development.md @@ -8,7 +8,7 @@ The website can be run locally through node.js or [Docker](https://www.docker.co Running the site locally is simple. Provided you have Docker installed, clone this repo, run `make`, and then visit `http://localhost:3000`. -The docker image is pre-built with all the website dependencies installed, which is what makes it so quick and simple, but also means if you need to change dependencies and test the changes within Docker, you'll need a new image. If this is something you need to do, you can run `make build-image` to generate a local Docker image with updated dependencies, then `make website-local` to use that image and preview. +The Docker image is pre-built with all the website dependencies installed, which is what makes it so quick and simple, but also means if you need to change dependencies and test the changes within Docker, you'll need a new image. If this is something you need to do, you can run `make build-image` to generate a local Docker image with updated dependencies, then `make website-local` to use that image and preview. ### With Node @@ -19,4 +19,4 @@ If your local development environment has a supported version (v10.0.0+) of [nod ...and then visit `http://localhost:3000`. -If you pull down new code from github, you should run `npm install` again. Otherwise, there's no need to re-run `npm install` each time the site is run, you can just run `npm start` to get it going. +If you pull down new code from GitHub, you should run `npm install` again. Otherwise, there's no need to re-run `npm install` each time the site is run, you can just run `npm start` to get it going.