Observability Best Practices

Welcome

This is the source for the AWS Observability Best Practices site. Everyone is welcome to contribute here, not just AWS employees!

This website is built using Docusaurus, a modern static website generator. You need to install npm as a prerequisite.

cd docusaurus
$ (yarn | npm ) install

$ yarn start [or] npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

$ yarn build [or] npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Using SSH with yarn:

$ USE_SSH=true yarn deploy

Using SSH with npm:

$ USE_SSH=true  npm run serve

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

See CONTRIBUTING for more information.

This library is licensed under the MIT-0 License. See the LICENSE file.