Add Prettier tool & normalize markdown of selected files (open-telemetry#1290)

Author: chalin

CONTRIBUTING.md

@@ -13,30 +13,30 @@ files][].
 These instructions are for [Gitpod.io][], adjust as needed for your favorite
 cloud IDE:
 
- 1. Fork this repo. For help, see [Fork a repo][Fork].
- 2. From [gitpod.io/workspaces][], create a new workspace (do this only once) or
+1.  Fork this repo. For help, see [Fork a repo][fork].
+2.  From [gitpod.io/workspaces][], create a new workspace (do this only once) or
     open an existing workspace over your fork. You can also visit a link of the
     form:
     <https://gitpod.io#https://github.com/YOUR_GITHUB_ID/opentelemetry.io>.
 
     > **Note**: If you have the necessary permissions to work from this repo, or
-    just want to look around, open
-    <https://gitpod.io/#https://github.com/open-telemetry/opentelemetry.io>.
+    > just want to look around, open
+    > <https://gitpod.io/#https://github.com/open-telemetry/opentelemetry.io>.
 
 Gitpod will automatically install the repo-specific packages for you. You're now
 ready to [build](#build), [serve](#serve) and/or make updates to the website
 files.
 
 ### Local setup
 
- 1. Install the latest [LTS release][] of **Node**. We recommend using
+1.  Install the latest [LTS release][] of **Node**. We recommend using
     **[nvm][]** to manage your Node installation (Linux command shown):
     ```console
     $ nvm install --lts
     ```
- 2. [Fork][] and then [clone][] this repo.
- 3. Change to the repo directory.
- 4. Get npm packages and other prerequisites:
+2.  [Fork][] and then [clone][] this repo.
+3.  Change to the repo directory.
+4.  Get npm packages and other prerequisites:
     ```console
     $ npm install
     ```
@@ -62,13 +62,13 @@ To **serve** the site run:
 $ npm run serve
 ```
 
-> **Note 1**: The Netlify CLI will locally serve the site at  at [localhost:8888][].
+> **Note 1**: The Netlify CLI will locally serve the site at [localhost:8888][].
 
 > **Note 2**: The serve command serves files from memory, not from disk.
 
 > **Note 3**: See an error like `too many open files` or `pipe failed` under
-> macOS? You may need to increase the file descriptor limit. See [Hugo issue
-> #6109](https://github.com/gohugoio/hugo/issues/6109).
+> macOS? You may need to increase the file descriptor limit. See
+> [Hugo issue #6109](https://github.com/gohugoio/hugo/issues/6109).
 
 ## Content and submodules
 
@@ -81,8 +81,10 @@ The website is built from the following content:
 Note that nonstandard mount points and symlinked sections under `content/` refer
 to directories under [content-modules][], and no where else.
 
-[config.yaml]: https://github.com/open-telemetry/opentelemetry.io/blob/main/config.yaml
-[content-modules]: https://github.com/open-telemetry/opentelemetry.io/tree/main/content-modules
+[config.yaml]:
+  https://github.com/open-telemetry/opentelemetry.io/blob/main/config.yaml
+[content-modules]:
+  https://github.com/open-telemetry/opentelemetry.io/tree/main/content-modules
 
 ## Submitting a change
 
@@ -100,11 +102,11 @@ that the corresponding submodule is linked to, rather than inside the submodule
 itself.
 
 > **For expert contributors**, you can work directly in the submodule. You'll
-then be able to directly build and serve your (submodule) changes. By default,
-the CI scripts get submodules on every invocation. To prevent this behavior
-while you work within a submodule, set the environment variable `GET="no"`.
-You'll also need to `git fetch --unshallow` the submodule before you can submit
-a PR. Alternatively, set `DEPTH=" "` and re-fetch submodules.
+> then be able to directly build and serve your (submodule) changes. By default,
+> the CI scripts get submodules on every invocation. To prevent this behavior
+> while you work within a submodule, set the environment variable `GET="no"`.
+> You'll also need to `git fetch --unshallow` the submodule before you can
+> submit a PR. Alternatively, set `DEPTH=" "` and re-fetch submodules.
 
 ## Site deploys and PR previews
 
@@ -117,15 +119,19 @@ the production server.
 To see deploy logs and more, visit project's [dashboard][] -- Netlify login
 required.
 
-[clone]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
+[clone]:
+  https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
 [dashboard]: https://app.netlify.com/sites/opentelemetry/overview
-[deploy preview]: https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/
-[Editing files]: https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files
-[Fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
-[Gitpod.io]: https://gitpod.io
+[deploy preview]:
+  https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/
+[editing files]:
+  https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files
+[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
+[gitpod.io]: https://gitpod.io
 [gitpod.io/workspaces]: https://gitpod.io/workspaces
-[Hugo]: https://gohugo.io
+[hugo]: https://gohugo.io
 [localhost:8888]: http://localhost:8888
-[LTS release]: https://nodejs.org/en/about/releases/
-[Netlify]: https://netlify.com
-[nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
+[lts release]: https://nodejs.org/en/about/releases/
+[netlify]: https://netlify.com
+[nvm]:
+  https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating

README.md

@@ -1,21 +1,21 @@
 # <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry Icon" width="45" height=""> OpenTelemetry.io
 
 This is the source repo for the [OpenTelemetry][] website and project
-documentation. The site is [built][CONTRIBUTING.md] using [Hugo][] and hosted on
+documentation. The site is [built][contributing.md] using [Hugo][] and hosted on
 [Netlify][].
 
 ## Adding a project to the OpenTelemetry Registry
 
 Do you maintain or contribute to an integration for OpenTelemetry? We'd love to
 feature your project in the [registry][]!
 
-To add your project, submit a [pull request][PR]. You'll need to create a data
+To add your project, submit a [pull request][pr]. You'll need to create a data
 file in `/content/en/registry` for your project. You can find a template in
 `./templates/registry-entry.md`
 
 ## Submitting a blog post
 
-Follow the [setup instructions][CONTRIBUTING.md] then, to create a skeletal blog
+Follow the [setup instructions][contributing.md] then, to create a skeletal blog
 post, run the following command from the repo root:
 
 ```console
@@ -25,33 +25,40 @@ $ hugo new content/en/blog/2022/file-name-for-your-blog-post.md
 Start editing the markdown file at the path you provided in the previous
 command. The file is initialized from the blog-post starter under
 [archetypes](archetypes). Once your post is ready, submit it through a [pull
-request][PR].
+request][pr].
 
 ## Contributing
 
 See [CONTRIBUTING.md][].
 
 Roles:
+
 - Approvers: [@open-telemetry/docs-approvers][]
 - Maintainers: [@open-telemetry/docs-maintainers][]
 - Blog approvers: [@open-telemetry/blog-approvers][]
 
 Learn more about roles in the [community repository][]. Thanks to [all who have
 already contributed][contributors]!
 
-##  Licenses
+## Licenses
 
 - Documentation: [CC-BY-4.0](LICENSE)
 - Code: [Apache-2.0](LICENSE-CODE)
 
-[@open-telemetry/blog-approvers]: https://github.com/orgs/open-telemetry/teams/blog-approvers
-[@open-telemetry/docs-approvers]: https://github.com/orgs/open-telemetry/teams/docs-approvers
-[@open-telemetry/docs-maintainers]: https://github.com/orgs/open-telemetry/teams/docs-maintainers
-[community repository]: https://github.com/open-telemetry/community/blob/main/community-membership.md
-[CONTRIBUTING.md]: CONTRIBUTING.md
-[contributors]: https://github.com/open-telemetry/opentelemetry.io/graphs/contributors
-[Hugo]: https://gohugo.io
-[Netlify]: https://netlify.com
-[OpenTelemetry]: https://opentelemetry.io
-[PR]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
+[@open-telemetry/blog-approvers]:
+  https://github.com/orgs/open-telemetry/teams/blog-approvers
+[@open-telemetry/docs-approvers]:
+  https://github.com/orgs/open-telemetry/teams/docs-approvers
+[@open-telemetry/docs-maintainers]:
+  https://github.com/orgs/open-telemetry/teams/docs-maintainers
+[community repository]:
+  https://github.com/open-telemetry/community/blob/main/community-membership.md
+[contributing.md]: CONTRIBUTING.md
+[contributors]:
+  https://github.com/open-telemetry/opentelemetry.io/graphs/contributors
+[hugo]: https://gohugo.io
+[netlify]: https://netlify.com
+[opentelemetry]: https://opentelemetry.io
+[pr]:
+  https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
 [registry]: https://opentelemetry.io/registry/

content/en/_index.md

@@ -1,66 +1,85 @@
 ---
 title: OpenTelemetry
 show_banner: true
-mission_url: https://github.com/open-telemetry/community/blob/main/mission-vision-values.md#otel-mission-vision-and-values
 ---
 
 {{< blocks/cover image_anchor="top" height="max" color="primary" >}}
 <img src="/img/logos/opentelemetry-horizontal-color.svg" class="otel-logo" alt="OpenTelemetry"/>
+
 <h1>High-quality, ubiquitous, and portable telemetry to enable effective observability</h1>
 
 <div class="l-primary-buttons mt-5">
 
-- [Learn more]({{< relref "/docs/concepts" >}})
-- <a href="{{<param mission_url >}}" target="_blank" rel="noopener">Mission and vision</a>
+- [Learn more](/docs/concepts/)
+- [Mission and vision][]
+
+[mission and vision]:
+  https://github.com/open-telemetry/community/blob/main/mission-vision-values.md#otel-mission-vision-and-values
+
 </div>
 
 <div class="h3 mt-4">Get started!</div>
 <div class="l-get-started-buttons">
 
-- [Collector]({{< relref "/docs/collector/getting-started" >}})
-- [Java]({{< relref "/docs/instrumentation/java/getting-started" >}})
-- [Go]({{< relref "/docs/instrumentation/go/getting-started" >}})
-- [.NET]({{< relref "/docs/instrumentation/net/getting-started" >}})
-- [JavaScript]({{< relref "/docs/instrumentation/js/getting-started" >}})
-- [<i class="fas fa-ellipsis-h"></i>]({{< relref "/docs/instrumentation" >}})
+- [Collector](/docs/collector/getting-started/)
+- [Java](/docs/instrumentation/java/getting-started/)
+- [Go](/docs/instrumentation/go/getting-started/)
+- [.NET](/docs/instrumentation/net/getting-started/)
+- [JavaScript](/docs/instrumentation/js/getting-started/)
+- [<i class="fas fa-ellipsis-h"></i>](/docs/instrumentation/)
 </div>
 {{< /blocks/cover >}}
 
 {{% blocks/lead color="white" %}}
+
 OpenTelemetry is a collection of tools, APIs, and SDKs. Use it to instrument,
-generate, collect, and export telemetry data (metrics, logs, and traces) to
-help you analyze your software's performance and behavior.
+generate, collect, and export telemetry data (metrics, logs, and traces) to help
+you analyze your software's performance and behavior.
+
+> OpenTelemetry is **generally available** across
+> [several languages](/docs/instrumentation/) and is suitable for use.
 
-> OpenTelemetry is **generally available** across [several languages]({{< relref "/docs/instrumentation" >}}) and is suitable for use.
 {{% /blocks/lead %}}
 
 {{% blocks/section color="dark" %}}
 
 {{% blocks/feature icon="fas fa-chart-line" title="Traces, Metrics, Logs"%}}
-Create and collect telemetry data from your services and software, then forward them to a variety of analysis tools.
-{{% /blocks/feature %}}
+
+Create and collect telemetry data from your services and software, then forward
+them to a variety of analysis tools. {{% /blocks/feature %}}
 
 {{% blocks/feature icon="fas fa-magic" title="Drop-In Instrumentation"%}}
-OpenTelemetry integrates with popular libraries and frameworks such as [Spring](https://spring.io/), [ASP.NET Core](https://docs.microsoft.com/aspnet/core), [Express](https://expressjs.com/), [Quarkus](https://quarkus.io/), and more! Installation and integration can be as simple as a few lines of code.
+
+OpenTelemetry integrates with popular libraries and frameworks such as
+[Spring](https://spring.io),
+[ASP.NET Core](https://docs.microsoft.com/aspnet/core),
+[Express](https://expressjs.com), [Quarkus](https://quarkus.io), and more!
+Installation and integration can be as simple as a few lines of code.
+
 {{% /blocks/feature %}}
 
 {{% blocks/feature icon="fab fa-github" title="Open Source, Vendor Neutral" url="https://github.com/open-telemetry"%}}
-100% Free and Open Source, OpenTelemetry is adopted and supported by [industry leaders](/vendors) in the observability space.
+
+100% Free and Open Source, OpenTelemetry is adopted and supported by
+[industry leaders](/vendors) in the observability space.
+
 {{% /blocks/feature %}}
 
 {{% /blocks/section %}}
 
 {{% blocks/section color="secondary" %}}
+
 <div id="cncf">
 
 **OpenTelemetry is a [CNCF][] [incubating][] project**.
 
 Formed through a merger of the OpenTracing and OpenCensus projects.
 
-[![CNCF logo][]][CNCF]
+[![CNCF logo][]][cncf]
 
-[CNCF]: https://cncf.io/
-[CNCF logo]: /img/logos/cncf-white.svg
+[cncf]: https://cncf.io
+[cncf logo]: /img/logos/cncf-white.svg
 [incubating]: https://www.cncf.io/projects/
+
 </div>
 {{% /blocks/section %}}

content/en/community/_index.md

@@ -1,22 +1,29 @@
 ---
 title: Community
-menu:
-  main:
-    weight: 40
+menu: { main: { weight: 40 } }
 ---
 
 {{% blocks/section color="dark" %}}
 
 {{% blocks/feature icon="fas fa-users" title="Special Interest Groups" url="https://github.com/open-telemetry/community#special-interest-groups"%}}
-We organize the community into Special Interest Groups (SIGs) in order to improve our workflow and more easily manage a community project.
+
+We organize the community into Special Interest Groups (SIGs) in order to
+improve our workflow and more easily manage a community project.
+
 {{% /blocks/feature %}}
 
 {{% blocks/feature icon="fab fa-github" title="Open Source Collaboration" url="/integrations"%}}
-OpenTelemetry collaborates and integrates with other open-source projects including Fluent Bit, Jaeger, Kubernetes, Prometheus, OpenMetrics, and W3C.
+
+OpenTelemetry collaborates and integrates with other open-source projects
+including Fluent Bit, Jaeger, Kubernetes, Prometheus, OpenMetrics, and W3C.
+
 {{% /blocks/feature %}}
 
 {{% blocks/feature icon="far fa-building" title="Vendor Supported" url="/vendors"%}}
-Several cloud providers and observability vendors distribute or natively support OpenTelemetry.
+
+Several cloud providers and observability vendors distribute or natively support
+OpenTelemetry.
+
 {{% /blocks/feature %}}
 
 {{% /blocks/section %}}
@@ -25,9 +32,11 @@ Several cloud providers and observability vendors distribute or natively support
 
 <div class="community-contribution">
 
-Interested in getting involved but not sure where to start? Check out our [community repo](https://github.com/open-telemetry/community) to find out more!
+Interested in getting involved but not sure where to start? Check out our
+[community repo](https://github.com/open-telemetry/community) to find out more!
 
-OpenTelemetry follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
+OpenTelemetry follows the
+[CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
 
 </div>
 

content/en/docs/_index.md

@@ -1,16 +1,13 @@
 ---
 title: Documentation
 linkTitle: Docs
-menu:
-  main:
-    weight: 10
+menu: { main: { weight: 10 } }
 ---
 
-OpenTelemetry is a set of APIs, SDKs, tooling and integrations that are
-designed for the creation and management of _telemetry data_ such as traces,
-metrics, and logs. The OpenTelemetry documentation is intended to broadly cover
-key terms, concepts, and instructions on how to use OpenTelemetry in your
-software.
+OpenTelemetry is a set of APIs, SDKs, tooling and integrations that are designed
+for the creation and management of _telemetry data_ such as traces, metrics, and
+logs. The OpenTelemetry documentation is intended to broadly cover key terms,
+concepts, and instructions on how to use OpenTelemetry in your software.
 
 ![Implementation of the OpenTelemetry Reference Architecture](https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/Reference_Architecture.svg)