Docs migration batch3

[nkammah]

This PR adds the remaining repositories to the Buildkite job rollout - see comm email about it.

Note to reviewers (ideally doc point persons):

1. Validate the build avoidance logic (if applicable)

The Buildkite PR bot has some build avoidance logic in place. Some repositories are configured to have the docs PR job for any changes in the repo. Other are configured for changes in the "docs" folder only.. I tried to follow the docs script build avoidance logic to determine how the repo should be configured, but you need to validate that this is actually the case.

Repos configured to trigger PR on every changes

• elastic/apm-agent-android
• elastic/apm-agent-dotnet
• elastic/apm-agent-go
• elastic/apm-agent-ios
• elastic/apm-agent-java
• elastic/apm-agent-nodejs
• elastic/apm-agent-php
• elastic/apm-agent-python
• elastic/apm-agent-ruby
• elastic/apm-agent-rum-js
• elastic/apm-aws-lambda
• elastic/apm-mutating-webhook
• elastic/apm-server
• elastic/elasticsearch-net
• elastic/elasticsearch-java
• elastic/enterprise-search-pubs
• elastic/go-elasticsearch

Repos configured to trigger PR on changes in the docs folder only

• elastic/ecs
• elastic/ecs-dotnet
• elastic/ecs-logging
• elastic/ecs-logging-go-logrus
• elastic/ecs-logging-go-zap
• elastic/ecs-logging-java
• elastic/ecs-logging-nodejs
• elastic/ecs-logging-php
• elastic/ecs-logging-python
• elastic/ecs-logging-ruby
• elastic/elasticsearch-hadoop
• elastic/elasticsearch-js
• elastic/elasticsearch-php
• elastic/elasticsearch-rs
• elastic/elasticsearch-ruby
• elastic/enterprise-search-python
• elastic/enterprise-search-php
• elastic/enterprise-search-ruby

2. Setup or update your GH action

As mentioned in the comm email, you can setup a GitHub action that posts a comment with various links to validate the doc

Here's an example setup you can copy in your repo.

3. Assess if you anticipate potential conflicts with other Buildkite pipelines in your repository

The docs PR job leverages the Buildkite PR bot. Before merging this PR, I will setup a webhook in your repository (following the instructions here). The config used for the PR job lives in the docs repo in the ./buildkite/pull-requests.org-wide.json file. There should not be any conflicts with your current jobs, but I like to be overly explicit with it.

4. What to expect once this is setup?

The Buildkite PR jobs are non-blocking at this time - but we need your help validating that they produce the same results than in Jenkins - see comm.

The below options are supported to trigger the docs builds:

run docs-build
run docs-build rebuild
run docs-build warnlinkcheck
run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option)
buildkite test this
buildkite test this rebuild
buildkite test this warnlinkcheck
buildkite test this skiplinkcheck (takes precedence over the warnlinkcheck option)

[github-actions]

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

• 🔨 Buildkite builds
• 📚 HTML diff: Buildkite - Jenkins
• 📙 Preview: Buildkite - Jenkins
• 🧪 Buildkite vs Jenkins diff

[bmorelli25]

I'm less certain of the non-Observability repositories, but everything I seen in Observability looks good. I can reach out to the individual teams to see if they want comments added to their PRs, but most of them don't have this currently and likely won't want it.

[chriscressman]

I'm waiting for the Clients team to confirm the logic for the following repos:

elastic/elasticsearch-net
elastic/elasticsearch-java
elastic/go-elasticsearch

It seems like the logic should be only when the docs directory changes, but they may know something I don't.

[nkammah]

elastic/elasticsearch-net

I followed the following logic:
elasticsearch-net

                    repo:   elasticsearch-net
                    path:   docs/
                  -
                    repo:   elasticsearch-net
                    path:   tests/Tests/Documentation

elasticsearch-java

sources:
                  -
                    repo:   elasticsearch-java
                    path:   docs/
                  -
                    repo:   elasticsearch-java
                    path:   java-client/src/test/java/co/elastic/clients/documentation

go-elasticserch

                sources:
                  -
                    repo:   go-elasticsearch
                    path:   .doc/

[chriscressman]

I can follow up if any changes are needed for client repos.