Add cluster doc code examples

[anniegale9538]

Hello!

I'm adding cluster doc code examples per #2429

Thanks, @pquentin you're a hero!

cc @stefnestor

[cla-checker-service]

💚 CLA has been signed

[github-actions]

A documentation preview will be available soon.

• 🔨 Buildkite builds
• 📚 HTML diff
• 📙 Preview page

Request a new doc build by commenting

• Rebuild this PR: run docs-build
• Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.}

[pquentin]

This looks great, thank you! And a great start towards adding more cluster docs examples. And of course, you're the hero, not me.

The only issue is the CLA check. You don't have to sign one as an Elastic employee, but for this to work you have to use your elastic.co address, which you are not doing, see here: https://github.com/elastic/elasticsearch-py/commit/2bcbf9a20a34e2afef65b4621924d97cdd49cd31.patch. You'll have to amend your commit to include the correct email and force push, I'm happy to explain more if you'd like.

[stefnestor]

👋 @pquentin, thanks 💚! Could you kindly explain a bit more 🙏?

I think I got us close but not quite and I'm not sure how to fix. Annie was moving between two Github accounts (personal @scranberryjam to Elastician @anniegale9538 ) and signed the CLA agreement under both Github usernames (though the second one which we believe is attached to this PR - since we were doing the commit together zooming sharing her work computer's screen - was CLA-signed after the above message popped up).

Could the problem be I missed setting Annie's Git PR email address which is what's needed to connect to the CLA agreement? E.g. Git Blame exposing email via -e doesn't list Annie's personal/work email 😕

elasticsearch-py$ git branch
* (HEAD detached at upstream/annie/adding_to_files_to_generate)

elasticsearch-py$ git blame -e docs/examples/1cecd4d87a92427175157d41859df2af.asciidoc
2bcbf9a20 (<[email protected]> 2024-02-24 11:35:45 -0700  1) // cluster/allocation-explain.asciidoc:10

[anniegale9538]

@stefnestor @pquentin I am wondering if it happened because I had "Keep my email addresses private" marked under my email on my anniegale9538 github account 😞 I unclicked that and am verifying my user.email now!

[pquentin]

Sorry for the delay! Indeed the issue here is the email in the git commit, not the GitHub user. You're going to have to amend the commit to include the correct email, and then do a force push:

git commit --amend --author="Annie Hansen <[email protected]>"
git push --force-with-lease

And to be sure you don't hit this issue for your next PRs, make sure to fix the email globally too:

git config --global user.name "Annie Hansen"
git config --global user.email "[email protected]"

https://www.git-tower.com/learn/git/faq/change-author-name-email is a good reference on that topic.

Hope that helps! If not, I'm also happy to assist more.

[anniegale9538]

YES!

Author: Annie Hansen ***@***.***> Date: Tue Feb 27 18:57:51 2024 -0700 adding cluster doc code examples

I went a bit if a different root because it wasn't loving git commit --amend --author="Annie Hansen ***@***.***>" I did a git reset from main, checked out the changes from my original commit and just recommitted everything. It does leave a dangling commit, but I am under the impression --append has a similar result, if that is wrong, my apologies!

…

On Tue, Feb 27, 2024 at 1:15 PM Quentin Pradet ***@***.***> wrote: Sorry for the delay! Indeed the issue here is the email in the git commit, not the GitHub user. You're going to have to amend the commit to include the correct email, and then do a force push: git commit --amend --author="Annie Hansen ***@***.***>" git push --force-with-lease And to be sure you don't hit this issue for your next PRs, make sure to fix the email globally too: git config --global user.name "Annie Hansen" git config --global user.email ***@***.***" https://www.git-tower.com/learn/git/faq/change-author-name-email is a good reference on that topic. Hope that helps! If not, I'm also happy to assist more. — Reply to this email directly, view it on GitHub <#2461 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BF7KDGOFIOCAG5OYXXP5SSDYVY5ETAVCNFSM6AAAAABDYGOXLGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRXGUYTQNBWGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[pquentin]

Thank you! LGTM.