Merge pull request #147 from sguruvar/docusaurus

Docusaurus and Architecture pattern changes

Author: bonclay7

.github/workflows/markdown-link-check.yaml

@@ -20,9 +20,9 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16.x'
+          node-version: 20
       - name: install markdown-link-check
-        run: npm install -g markdown-link-check@3.10.2
+        run: npm install -g markdown-link-check@3.12.2
       - name: markdown-link-check version
         run: npm list -g markdown-link-check
       - name: Run markdown-link-check on MD files

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
       - id: detect-aws-credentials
         args: ['--allow-missing-credentials']
   - repo: https://github.com/tcort/markdown-link-check
-    rev: v3.11.2
+    rev: v3.12.2
     hooks:
       - id: markdown-link-check
         args: ['-q', '-c .github/workflows/linkcheck.json']

docs/en/guides/choosing-a-tracing-agent.md

@@ -17,16 +17,18 @@ Any transaction tracing solution requires an agent and an integration into the u
 
 The SDKs included with X-Ray are part of a tightly integrated instrumentation solution offered by AWS. ADOT is part of a broader industry solution in which X-Ray is only one of many tracing solutions. You can implement end-to-end tracing in X-Ray using either approach, but it’s important to understand the differences in order to determine the most useful approach for you.
 
-!!! success
+:::info
 	We recommend instrumenting your application with the AWS Distro for OpenTelemetry if you need the following:
 
     * The ability to send traces to multiple different tracing backends without having to re-instrument your code. For example, of you wish to shift from using the X-Ray console to [Zipkin](https://zipkin.io), then only configuration of the collector would change, leaving your applicaiton code untouched.
 
     * Support for a large number of library instrumentations for each language, maintained by the OpenTelemetry community. 
+:::
 
-!!! success
+:::info
 	We recommend choosing an X-Ray SDK for instrumenting your application if you need the following:
 
     * A tightly integrated single-vendor solution.
 
     * Integration with X-Ray centralized sampling rules, including the ability to configure sampling rules from the X-Ray console and automatically use them across multiple hosts, when using Node.js, Python, Ruby, or .NET
+:::

docs/en/index.md

@@ -27,7 +27,7 @@ This site is organized into four categories:
 1. [Best practices for specific AWS tools (though these are largely fungible to other vendor products as well)](https://aws-observability.github.io/observability-best-practices/tools/cloudwatch_agent/)
 1. [Curated recipes for observability with AWS](https://aws-observability.github.io/observability-best-practices/recipes/)
 
-!!! success
+:::info
 	This site is based on real world use cases that AWS and our customers have solved for.
 
 	Observability is at the heart of modern application development, and a critical consideration when operating distributed systems, such as microservices, or complex applications with many external integrations. We consider it to be a leading indicator of a healthy workload, and we are pleased to share our experiences with you here!

docs/en/recipes/infra.md

@@ -28,7 +28,6 @@
 [alb-docs]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-monitoring.html
 [nlb-docs]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-monitoring.html
 [vpcfl]: https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html
-[vpcf-ws]: https://amazon-es-vpc-flowlogs.workshop.aws/en/
 [eks-cp]: https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html
 [lambda-docs]: https://docs.aws.amazon.com/lambda/latest/operatorguide/monitoring-observability.html
 [rds]: rds.md

docs/ja/recipes/infra.md

@@ -27,7 +27,6 @@
 [alb-docs]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-monitoring.html
 [nlb-docs]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-monitoring.html 
 [vpcfl]: https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html
-[vpcf-ws]: https://amazon-es-vpc-flowlogs.workshop.aws/en/
 [eks-cp]: https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html
 [lambda-docs]: https://docs.aws.amazon.com/lambda/latest/operatorguide/monitoring-observability.html
 [rds]: rds.md

docusaurus/observability-best-practices/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docusaurus/observability-best-practices/README.md

@@ -0,0 +1,62 @@
+# Observability Best Practices
+
+## Welcome
+
+This is the source for the [AWS Observability Best Practices site](https://aws-observability.github.io/observability-best-practices/). Everyone is welcome to contribute here, not just AWS employees!
+
+## How to run/develop this site
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+You need to install [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) as a prerequisite.
+
+### Installation
+
+```
+$ (yarn | npm ) install
+```
+
+### Local Development
+
+```
+$ 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.
+
+### Build
+
+```
+$ 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.
+
+### Deployment
+
+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.
+
+
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

docusaurus/observability-best-practices/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docusaurus/observability-best-practices/blog/2019-05-28-first-blog-post.md

@@ -0,0 +1,12 @@
+---
+slug: first-blog-post
+title: First Blog Post
+authors:
+  name: Gao Wei
+  title: Docusaurus Core Team
+  url: https://github.com/wgao19
+  image_url: https://github.com/wgao19.png
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet