Introduce additional textlint rules (#3011)

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>

Author: svrnm

.textlintrc.json

@@ -27,34 +27,86 @@
       "skip": [],
       "terms": [
         ".NET",
+        "Ajax",
         "Apache",
+        "API",
+        "AWS",
+        "Azure",
         "CNCF",
         "eBPF",
+        "ECMAScript",
+        "Elixir",
+        "Erlang",
+        "GCP",
+        "GitHub",
         "gRPC",
+        "GraphQL",
+        "ID",
+        "iOS",
         "HTTP",
         "Jaeger",
+        "Java",
+        "JavaScript",
+        "Jetty",
+        "JMX",
         "K8s",
+        "Kafka",
         "KubeCon",
         "Kubernetes",
+        "MacBook",
+        "macOS",
         "MySQL",
         "NGINX",
+        "OK",
         "OpenTelemetry Collector",
         "OTel",
         "OTEP",
+        "Phoenix",
         "PHP",
+        "Python",
         "PostgreSQL",
         "protobuf",
+        "Rails",
+        "Redis",
+        "Ruby",
+        "Rust",
+        "SemVer",
+        "SDK",
+        "SQL",
         "SQLite",
+        "Swift",
         "Thanos",
         "Traefik",
+        "TypeScript",
+        "URL",
+        "WordPress",
+        "YouTube",
         "Zend",
         "Zipkin",
+        ["3rd[- ]party", "third-party"],
+        ["bug[- ]fix(es)?", "bugfix$1"],
+        ["cpp", "C++"],
+        ["dotnet", ".NET"],
         ["[^\\.]json", "JSON"],
+        ["[^\\.]html", "HTML"],
+        ["he or she", "they"],
+        ["he/she", "they"],
+        ["\\(s\\)he", "they"],
+        ["id['’]?s", "IDs"],
+        ["Mac ?OS", "macOS"],
+        ["meta[- ]data", "metadata"],
         ["[Nn]ode\\.?[Jj][sS]", "Node.js"],
         ["open-source", "open source"],
         ["[Oo]pen[- ]?[Tt]elemetry", "OpenTelemetry"],
+        ["OS X", "macOS"],
+        ["postgres", "PostgreSQL"],
         ["psr[ -]?([0-9]+)", "PSR-$1"],
-        ["regexes", "regular expressions"]
+        ["React[ .]js", "React"],
+        ["regexp?(s)?", "regular expression$1"],
+        ["repo\\b", "repository"],
+        ["repos", "repositories"],
+        ["screen[- ]shot(s)?", "screenshot$1"],
+        ["time[- ]stamp(s)?", "timestamp$1"]
       ]
     }
   }

content/en/blog/2022/collector-builder-sample/index.md

@@ -284,12 +284,12 @@ config changes and new components as compiled into the updated image.
 ## Automate builds for secure, up-to-date images
 
 Building your own Collector allows you to control updates and rollouts of the
-Collector image. In this repo, we have some samples of how you can own your
-Collector build on GCP.
+Collector image. In this repository, we have some samples of how you can own
+your Collector build on GCP.
 
 Using a [Cloud Build](https://cloud.google.com/build) configuration supports
 serverless, automated builds for your Collector. By doing so you can benefit
-from new releases, features, and bug fixes in Collector components with minimal
+from new releases, features, and bugfixes in Collector components with minimal
 delay. Combined with
 [Artifact Registry](https://cloud.google.com/artifact-registry), these builds
 can be pushed as Docker images in your GCP project. This provides portability

content/en/blog/2022/debug-otel-with-otel/index.md

@@ -17,7 +17,7 @@ of OpenTelemetry to identify the root cause of bug in another feature.
 In this blog post, we want to share this interesting experience with you. By
 that, you will learn that minor differences in the language-specific
 implementations can have interesting implications and that you have a feature
-for java & python, which is here to help you to debug context propagation
+for Java and Python, which is here to help you to debug context propagation
 issues.
 
 ## The issue
@@ -27,14 +27,14 @@ issues.
 For the blog post [Learn how to instrument NGINX with OpenTelemetry][] we
 created a small sample app that had a frontend application in Node.js, that
 called an NGINX, which acted as a reverse proxy for a backend application in
-python.
+Python.
 
 Our goal was to create a re-usable `docker-compose` that would not only show
 people how to instrument NGINX with OpenTelemetry, but also how a distributed
 trace crossing the web server would look like.
 
 While Jaeger showed us a trace flowing from the frontend application down to the
-NGINX, the connection between NGINX and python app was not visible: we had two
+NGINX, the connection between NGINX and Python app was not visible: we had two
 disconnected traces.
 
 This came as a surprise, because in a prior test with a Java application as
@@ -44,7 +44,7 @@ application.
 ### Steps to reproduce
 
 Follow the instructions on how you can [put NGINX between two services][].
-Replace the java-based application with a python application, e.g. put following
+Replace the java-based application with a Python application, e.g. put following
 three files into the `backend` folder instead:
 
 - `app.py`:
@@ -156,21 +156,21 @@ the `frontend` down to NGINX, and another one only for the `python-app`.
 
 ### The hints
 
-Since the setup worked with a java application in the backend, we knew that the
-problem was either caused by the python application or by the combination of the
-NGINX instrumentation and the python application.
+Since the setup worked with a Java application in the backend, we knew that the
+problem was either caused by the Python application or by the combination of the
+NGINX instrumentation and the Python application.
 
-We could quickly rule out that the python application alone was the issue:
+We could quickly rule out that the Python application alone was the issue:
 trying out a simple Node.js application as backend, we got the same result: two
 traces, one from frontend to NGINX, another one for the Node.js application
 alone.
 
 With that, we knew that we had a propagation issue: the trace context was not
-transferred successfully from NGINX down to the python and Node.js application.
+transferred successfully from NGINX down to the Python and Node.js application.
 
 ### The analysis
 
-Knowing that the issue does not occur with java and that it is likely a broken
+Knowing that the issue does not occur with Java and that it is likely a broken
 propagation, we knew what we had to do: we needed to see the trace headers.
 
 Gladly, the instrumentations for [Java][] and [Python][] have a feature that

content/en/blog/2022/demo-announcement/index.md

@@ -14,7 +14,7 @@ represented, demo support will be extended to Metrics and Logs, and canonical
 scenarios will be documented for each signal, with fault injection, and more!
 
 If you want to skip the details then clone our
-[repo](https://github.com/open-telemetry/opentelemetry-demo) then run
+[repository](https://github.com/open-telemetry/opentelemetry-demo) then run
 `docker compose up`[^1] from the command line. There are a couple
 [technology requirements](https://github.com/open-telemetry/opentelemetry-demo-webstore#local-quickstart)
 so be sure to check those out too.
@@ -73,7 +73,7 @@ Otherwise the pre-existing feature set from the GCP demo remains the same:
   Node.js, Python, and Ruby)
   - Ruby support was added within the last 2 weeks of publishing date
 - Designed to work on docker locally
-- Uses redis cache
+- Uses Redis cache
 - Auto-instrumentation using instrumentation libraries Tracing support for the
   gRPC, Redis, and HTTP libraries
 - Jaeger visualizations for distributed traces, forwarded by OpenTelemetry
@@ -148,7 +148,7 @@ ourselves to just the items listed here.
 
 We’re still at the beginning of our journey but there’s great momentum behind
 this project. If you’re interested in contributing we’d love your support. There
-are links in our GitHub repo on how to get involved and you can
+are links in our GitHub repository on how to get involved and you can
 [track our overall progress](https://github.com/open-telemetry/opentelemetry-demo/issues)
 from there.
 

content/en/blog/2022/gc-elections.md

@@ -61,8 +61,8 @@ the community.
 ## Questions?
 
 For any election related questions, please file an issue on the
-[community repo](https://github.com/open-telemetry/community/issues) here and
-tag [@jpkrohling](https://github.com/jpkrohling),
+[community repository](https://github.com/open-telemetry/community/issues) here
+and tag [@jpkrohling](https://github.com/jpkrohling),
 [@bogdandrutu](https://github.com/bogdandrutu), and
 [@bhs](https://github.com/bhs). Or send us a message on
 [CNCF Slack](https://slack.cncf.io/) in

content/en/blog/2022/go-web-app-instrumentation/index.md

@@ -15,7 +15,7 @@ with OpenTelemetry Go without prior knowledge.
 We will start with creating a simple to-do app that uses Mongo and the Gin
 framework. Then, we will send tracing data to Jaeger Tracing for visualization.
 You can find all the relevant files in this
-[Github repository](https://github.com/aspecto-io/opentelemetry-examples/tree/master/go).
+[GitHub repository](https://github.com/aspecto-io/opentelemetry-examples/tree/master/go).
 
 ![OpenTelemetry Go - The Mandalorian](OpenTelemetry-Go-The-Mandalorian-2048x1406.png)
 

content/en/blog/2022/instrument-apache-httpd-server/index.md

@@ -22,7 +22,7 @@ quick guide to get started with the module.
 
 Getting started with the OpenTelemetry module for Apache HTTP Server is pretty
 simple, all you need is a docker engine and git. Download the source code from
-github and then build the docker image on CentOS7[^1]:
+GitHub and then build the docker image on CentOS7[^1]:
 
 ```sh
 git clone https://github.com/open-telemetry/opentelemetry-cpp-contrib
@@ -99,8 +99,8 @@ Zipkin backend. The following steps are required to be done.
 
   ![Php-Config](php-config.png)
 
-- Create a file named as `index.html` in the **/var/www/html** directory and add
-  the following text
+- Create a file named as `index.html` in the `**/var/www/html**` directory and
+  add the following text
 
   ```html
   <!doctype html>

content/en/blog/2022/instrument-nginx/index.md

@@ -195,7 +195,7 @@ might be a service calling NGINX to reach that down stream service.
 Add two more services to the running example:
 
 - A Node.js service called `frontend` that sits at the front and calls the NGINX
-- A java service called `backend` that sits behind the NGINX
+- A Java service called `backend` that sits behind the NGINX
 
 Update the `docker-compose` file to contain those 2 services and to overwrite
 the `default.conf` in NGINX:

content/en/blog/2022/k8s-otel-expose/index.md

@@ -39,7 +39,7 @@ article
 [How TLS provides identification, authentication, confidentiality, and integrity](https://www.ibm.com/docs/en/ibm-mq/9.1?topic=tls-how-provides-identification-authentication-confidentiality-integrity)
 and the Collector
 [TLS-Config](https://github.com/open-telemetry/opentelemetry-collector/blob/v0.58.0/config/configtls/README.md)
-description on Github.
+description on GitHub.
 
 If you are interested in using an external authentication provider, I advise you
 to have a look at the article
@@ -421,7 +421,7 @@ Kubernetes components, the configurations differ a lot. Overall the
 configuration is very error-prone. In the future the exposing of the collector
 should be simplified with the help of the OpenTelemetry operator. If you are
 interested in the development, you can follow
-[Github issue #902](https://github.com/open-telemetry/opentelemetry-operator/issues/902)
+[GitHub issue #902](https://github.com/open-telemetry/opentelemetry-operator/issues/902)
 to stay updated.
 
 ## References

content/en/blog/2022/otel-demo-app-nomad/index.md

@@ -42,15 +42,16 @@ In order to run the example in this tutorial, you’ll need the following:
 - [Docker](https://docker.com) (version 20.10.21 at the time of this writing)
 - [Vagrant](https://vagrantup.com) (version 2.3.1 at the time of this writing)
 
-### Tutorial Repos
+### Tutorial Repositories
 
-Below are the repos that we’ll be using for today’s tutorial:
+Below are the repositories that we’ll be using for today’s tutorial:
 
-- My modified [HashiQube Repo](https://github.com/avillela/hashiqube) (fork of
-  [servian/hashiqube](https://github.com/servian/hashiqube)). If you’re curious,
-  you can see what modifications I’ve made
+- My modified [HashiQube Repository](https://github.com/avillela/hashiqube)
+  (fork of [servian/hashiqube](https://github.com/servian/hashiqube)). If you’re
+  curious, you can see what modifications I’ve made
   [here](https://github.com/avillela/hashiqube).
-- My [Nomad Conversions](https://github.com/avillela/nomad-conversions) repo
+- My [Nomad Conversions](https://github.com/avillela/nomad-conversions)
+  repository
 
 ### HashiQube Setup
 
@@ -59,7 +60,7 @@ Before you start, just a friendly reminder that HashiQube by default runs
 on Docker. In addition, we’ll be deploying 21 job specs to Nomad. This means
 that we’ll need a decent amount of CPU and RAM, so please make sure that you
 have enough resources allocated in your Docker desktop. For reference, I’m
-running an M1 Macbook Pro with 8 cores and 32 GB RAM. My Docker Desktop Resource
+running an M1 MacBook Pro with 8 cores and 32 GB RAM. My Docker Desktop Resource
 settings are as follows:
 
 - **CPUs:** 3
@@ -125,7 +126,7 @@ vagrant ssh
 
 We’re finally ready to deploy the OTel Demo App!
 
-First, let’s clone the repo, and go to our working directory:
+First, let’s clone the repository, and go to our working directory:
 
 ```shell
 git clone https://github.com/avillela/nomad-conversions.git
@@ -229,7 +230,7 @@ of the services:
 ![Screen capture of Consul service health. All services healthy.](consul-service-health.png 'Screen capture of Consul service health. All services healthy.')
 
 By default, unhealthy services show up at the top, with a red “x” next to them.
-Since we don’t see any nasty red “x”s in the above screen shot, we know that our
+Since we don’t see any nasty red “x”s in the above screenshot, we know that our
 services are lookin’ good!
 
 #### 5- Access the OTel Demo App

content/en/blog/2022/tail-sampling/index.md

@@ -134,8 +134,8 @@ You also have the flexibility to add other policies. Here are a few examples:
 - `latency`: Sample based on the duration of the trace. For example, you could
   sample all traces that take longer than 5 seconds.
 - `string_attribute`: Sample based on string attribute values, both exact and
-  regex value matches are supported. For example, you could sample based on
-  specific custom attribute values.
+  regular expression value matches are supported. For example, you could sample
+  based on specific custom attribute values.
 
 ## Potential issues with tail sampling
 
@@ -215,7 +215,7 @@ under active development, including the tail sampling processor and the
 collector. For the tail sampling processor, there is currently an
 [open issue](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/1797)
 in the
-[collector-contrib repo](https://github.com/open-telemetry/opentelemetry-collector-contrib)
+[collector-contrib repository](https://github.com/open-telemetry/opentelemetry-collector-contrib)
 to discuss the future of this processor that centers around replacing it with
 separate processors, so that the chain of events is well-defined and understood.
 One of the main issues the community is trying to figure out is whether using

content/en/blog/2022/troubleshooting-nodejs.md

@@ -77,8 +77,8 @@ To use an auto instrumentation library in your service, you’ll need to:
 For most users, the following should cover it:
 
 ```js
-// First run `npm install @opentelemetry/instrumentation-foo @opentelemetry/instrumentation-bar
-// Replace foo and bar with the actual packages you need to instrument (http/mysql/redis etc)
+// First run: npm install @opentelemetry/instrumentation-foo @opentelemetry/instrumentation-bar
+// Replace foo and bar with the actual packages you need to instrument (HTTP/mySQL/Redis etc)
 import { FooInstrumentation } from '@opentelemetry/instrumentation-foo';
 import { BarInstrumentation } from '@opentelemetry/instrumentation-bar';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
@@ -88,7 +88,7 @@ registerInstrumentations({
 });
 ```
 
-For advanced users who choose to use the low-level api instead of calling
+For advanced users who choose to use the low-level API instead of calling
 `registerInstrumentations`, make sure your instrumentation is set to use the
 right tracer provider and that you call `enable()` if appropriate.
 
@@ -152,9 +152,9 @@ might not be supported and thus no spans will be created.
 
 Consult the documentation of the library you are using to verify if your version
 is compatible. This data is usually found in the README for the instrumentation,
-for example see the [redis README][].
+for example see the [Redis README][].
 
-[redis readme]:
+[Redis readme]:
   https://www.npmjs.com/package/@opentelemetry/instrumentation-redis
 
 ## No Recording and Non-Sampled Spans
@@ -367,7 +367,7 @@ channels:
 
 ### Resources
 
-- [Opentelemetry-js GitHub repo](https://github.com/open-telemetry/opentelemetry-js)
+- [Opentelemetry-js GitHub repository](https://github.com/open-telemetry/opentelemetry-js)
 - [The OpenTelemetry Bootcamp](https://www.aspecto.io/opentelemetry-bootcamp/)
 - [OpenTelemetry docs](/docs/)
 

content/en/blog/2022/v1.0-trio.md

@@ -6,7 +6,7 @@ canonical_url: https://medium.com/opentelemetry/opentelemetry-erlang-elixir-java
 ---
 
 We are kicking off the new year with a bang! In the last couple months, three
-new languages (Ruby, Javascript, and Erlang/Elixir) have had their first 1.0
+new languages (Ruby, JavaScript, and Erlang/Elixir) have had their first 1.0
 releases, joining the existing GA releases from C++, Go, Java, .Net, Python and
 Swift. Read all the details from the [announcement][].
 

content/en/blog/2023/demo-birthday/index.md

@@ -15,7 +15,7 @@ since we declared general availability with our
 ### Project Milestones
 
 The demo has achieved remarkable milestones in its first year, with more than
-**70 contributors, 20 official vendor forks, 780 Github stars, and 180K Docker
+**70 contributors, 20 official vendor forks, 780 GitHub stars, and 180K Docker
 pulls**. The project team has been hard at work adding new capabilities and
 improving on existing ones with more than _460 merged PRs, 5 re-written services
 in new languages, and 7 brand new components / services_.
@@ -33,7 +33,7 @@ changed between our 1.0.0 and 1.4.0 releases? Quite a lot actually.
   Helm_
 - **More out of the box dashboards like our
   [Collector Data Flow Dashboard](/docs/demo/collector-data-flow-dashboard/)**
-- **A myriad of frontend bug fixes**
+- **A myriad of frontend bugfixes**
 - _Our first
   [Connector](https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md)
   in the Collector to demonstrate how telemetry pipelines can be linked_