diff --git a/.github/workflows/docs-freeze.yml b/.github/workflows/docs-freeze.yml new file mode 100644 index 0000000000..4ea40b7e25 --- /dev/null +++ b/.github/workflows/docs-freeze.yml @@ -0,0 +1,44 @@ +name: Comment on PR for .asciidoc changes + +on: + pull_request: + types: + - synchronize + - opened + - reopened + branches: + - main + - master + - "9.0" + +jobs: + comment-on-asciidoc-change: + runs-on: ubuntu-latest + + steps: + - name: Checkout the repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 # This is important to fetch all history + + - name: Check for changes in .asciidoc files + id: check-files + run: | + git fetch origin ${{ github.base_ref }} + if git diff --name-only origin/${{ github.base_ref }}..HEAD | grep -E '\.asciidoc$'; then + echo "asciidoc_changed=true" >> $GITHUB_ENV + else + echo "asciidoc_changed=false" >> $GITHUB_ENV + fi + + - name: Add a comment if .asciidoc files changed + if: env.asciidoc_changed == 'true' + uses: actions/github-script@v6 + with: + script: | + github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.payload.pull_request.number, + body: 'It looks like this PR modifies one or more `.asciidoc` files. The documentation is currently under a documentation freeze. Please do not merge this PR. See [link](link) to learn more.' + }); diff --git a/docs/en/observability/apm/act-on-data/alerts.asciidoc b/docs/en/observability/apm/act-on-data/alerts.asciidoc index 3650ece61f..6f0de65976 100644 --- a/docs/en/observability/apm/act-on-data/alerts.asciidoc +++ b/docs/en/observability/apm/act-on-data/alerts.asciidoc @@ -95,5 +95,5 @@ From this page, you can disable, mute, and delete APM alerts. See {kibana-ref}/alerting-getting-started.html[Alerting] for more information. NOTE: If you are using an **on-premise** Elastic Stack deployment with security, -communication between Elasticsearch and Kibana must have TLS configured. +communication between {es} and Kibana must have TLS configured. More information is in the alerting {kibana-ref}/alerting-setup.html#alerting-prerequisites[prerequisites].