Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add syntax quick ref #834

Merged
merged 64 commits into from
Apr 7, 2025
Merged

Add syntax quick ref #834

merged 64 commits into from
Apr 7, 2025

Conversation

marciw
Copy link
Contributor

@marciw marciw commented Mar 25, 2025

Add a syntax quick reference with brief guidance that points to the full syntax guide.

Preview

https://github.com/elastic/docs-projects/issues/458

@marciw marciw added the documentation Improvements or additions to documentation label Mar 25, 2025
@alaudazzi
Copy link
Contributor

@marciw I started adding some elements, mainly to test the layout. Feel free to modify it where needed :)

@marciw marciw changed the title [WIP] Add quick ref [WIP] Add syntax quick ref Mar 29, 2025
@marciw
Copy link
Contributor Author

marciw commented Mar 29, 2025

@alaudazzi I pushed a commit with an example entry -- see the issue for more details

@alaudazzi
Copy link
Contributor

@marciw it seems that the Headings in the Output example are taken into account on the right TOC:


image

@alaudazzi
Copy link
Contributor

@marciw Thanks for your last edits, it looks nice! We can always iterate if needed.

@alaudazzi alaudazzi self-requested a review April 7, 2025 01:58
Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

🚀

@marciw marciw changed the title [WIP] Add syntax quick ref Add syntax quick ref Apr 7, 2025
@marciw marciw requested a review from reakaleek April 7, 2025 14:12
@marciw
Copy link
Contributor Author

marciw commented Apr 7, 2025

@reakaleek does this look OK to you now? I think it's good to go (but need codeowner approval) 🙏

@marciw marciw enabled auto-merge (squash) April 7, 2025 14:17
Copy link
Member

@reakaleek reakaleek left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines +267 to +275
```markdown
```json
{
"match": {
"message": "search text" // Searches the message field
}
}
```
```
Copy link
Member

Choose a reason for hiding this comment

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

nit: I guess this is supposed to be json, not markdown.

Suggested change
```markdown
```json
{
"match": {
"message": "search text" // Searches the message field
}
}
```
```
```json
{
"match": {
"message": "search text" // Searches the message field
}
}
```

@marciw marciw merged commit 918918c into main Apr 7, 2025
15 checks passed
@marciw marciw deleted the syntax-quick-ref branch April 7, 2025 14:41
@bmorelli25
Copy link
Member

Thanks, y'all!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants