Skip to content

Conversation

@leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Oct 6, 2025

  • Adds a new Kibana quickstart for contributing to API docs

@leemthompo leemthompo self-assigned this Oct 6, 2025
@leemthompo leemthompo marked this pull request as ready for review October 7, 2025 10:48
@leemthompo leemthompo requested a review from a team as a code owner October 7, 2025 10:48
@leemthompo
Copy link
Contributor Author

@charlotte-hoblik as you have a ticket related to using these steps, you'd be an ideal reviewer for this PR :)

@leemthompo
Copy link
Contributor Author

thanks for all the comments @lcawl, I can refactor this into more comprehensive coverage and we can decide whether it makes sense to cram it all into the quickstart or add more overview information elsewhere in these guidelines for Kibana (i.e. a sibling to https://www.elastic.co/docs/contribute-docs/api-docs/overview#example-elasticsearch)

@leemthompo leemthompo marked this pull request as draft October 10, 2025 07:32
@leemthompo
Copy link
Contributor Author

(Putting this back in draft for time being)

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat addition. I just got to test these instructions for Kibana and besides a few small things, this worked out well. Thanks for putting it together

@leemthompo 💅

@leemthompo
Copy link
Contributor Author

db5c053 summary:

Structural changes

  • split quickstart.md into elasticsearch-api-docs-quickstart.md and kibana-api-docs-quickstart.md
  • added synchronized tab groups throughout the kibana quickstart

Lisa:

  • added fork/clone instructions with upstream remote setup
  • scoped docker requirement to code-generated APIs using tabs
    • added link to get docker
  • added workflow differentiation between code-generated and manually-maintained APIs
  • added "open a pull request" step
  • deleted Enable OAS in Kibana step

Florent:

  • clarified capture_oas_snapshot runs automatically in CI
  • added docker login requirement for elasticians
  • add bump-cli installation command and said "ensure installed and up to date"

Other content changes

  • added additional context that CI runs steps automatically, local execution is optional
  • consolidated YAML examples section for clarity
  • added introductory paragraph about CI automation before stepper

@leemthompo leemthompo marked this pull request as ready for review October 20, 2025 07:46
@leemthompo leemthompo requested a review from a team as a code owner October 20, 2025 07:46
@leemthompo
Copy link
Contributor Author

This is not urgent urgent for review, especially given 9.2 goes out this week :)

leemthompo and others added 2 commits October 21, 2025 15:26
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
@leemthompo
Copy link
Contributor Author

thanks for catching all those @lcawl 👍

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two more comments then LGTM, thanks for wrestling this into submission!

Co-authored-by: Lisa Cawley <[email protected]>
@leemthompo
Copy link
Contributor Author

cc @KOTungseth adds guidelines for working with Kibana APIs

@leemthompo leemthompo enabled auto-merge (squash) October 29, 2025 14:04
@leemthompo leemthompo merged commit b65dfff into main Oct 29, 2025
6 of 7 checks passed
@leemthompo leemthompo deleted the leemthompo/kibana-api-docs-workflow branch October 29, 2025 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants