Skip to content

Conversation

flobernd
Copy link
Member

@flobernd flobernd commented Oct 2, 2024

Adds copy/paste-able examples for very common use-cases.

@flobernd flobernd added 8.x Relates to a 8.x client version backport serverless Area: Documentation labels Oct 2, 2024
@flobernd flobernd requested review from marciw and szabosteve October 2, 2024 07:43
Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

Thank you @flobernd !

Small edits for Elastic docs style for headings.

One thought: would it make sense to have an examples subfolder under usage to collect the 4 pages? Not sure...

Am also going to add a commit to add the pages to the nav

@flobernd
Copy link
Member Author

flobernd commented Oct 4, 2024

Thanks for the review and the suggestions @marciw 🙂

One thought: would it make sense to have an examples subfolder under usage to collect the 4 pages? Not sure...

Could definitely make sense - especially when we add even more examples.

Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

Somehow we ended up with a couple of duplicate headings -- going to accept these suggestions to fix

Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

LGTM!

@flobernd
Copy link
Member Author

flobernd commented Oct 5, 2024

Thank you again @marciw!

Seems I somehow messed up the rebase which caused the headers to get duplicated.

@flobernd flobernd merged commit 5cde969 into main Oct 5, 2024
6 of 19 checks passed
@flobernd flobernd deleted the doc-examples branch October 5, 2024 10:40
Copy link
Contributor

github-actions bot commented Oct 5, 2024

The backport to serverless failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-serverless serverless
# Navigate to the new working tree
cd .worktrees/backport-serverless
# Create a new branch
git switch --create backport-8374-to-serverless
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 5cde9691b5a4613068ae1c97e8c6268575f77d57
# Push it to GitHub
git push --set-upstream origin backport-8374-to-serverless
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-serverless

Then, create a pull request where the base branch is serverless and the compare/head branch is backport-8374-to-serverless.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

8.x Relates to a 8.x client version Area: Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants