Skip to content

Draft reference overviews: Kibana #14

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 7 commits into from
Closed

Draft reference overviews: Kibana #14

wants to merge 7 commits into from

Conversation

@lcawl
Copy link

@lcawl lcawl commented Jan 21, 2025 •
edited
Loading

This PR plays with adding some missing pages for the reference section of the docs

NOTE: This PR also removes an unrelated blurb that was causing this build failure:

Error: caution_ref does not exist in admonitions.md.

Preview

image

@lcawl lcawl requested a review from alaudazzi January 21, 2025 03:44
@alaudazzi
Copy link

alaudazzi commented Jan 21, 2025

@lcawl
Great start! One small consideration about naming conventions: as we don't know yet how pieces will move in the final system structure, how about keeping the overview files unique?
docs/source/reference-overview/kibana/overview.md
=>
docs/source/reference-overview/kibana/kibana-overview.md

This was referenced Jan 21, 2025
Closed
Closed
@lcawl
Copy link
Author

lcawl commented Jan 22, 2025

@lcawl Great start! One small consideration about naming conventions: as we don't know yet how pieces will move in the final system structure, how about keeping the overview files unique? docs/source/reference-overview/kibana/overview.md => docs/source/reference-overview/kibana/kibana-overview.md

Good suggestion! I've flattened the folder since the new filenames make it redundant IMO.

alaudazzi
alaudazzi approved these changes Jan 22, 2025
View reviewed changes
Copy link

@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.

Left a few minor comments.

docs/source/reference-overview/kibana-configuration.md
@@ -0,0 +1,31 @@
---
title: Kibana configuration reference
navigation_title: "Configuration reference"
Copy link

@alaudazzi alaudazzi Jan 22, 2025

Choose a reason for hiding this comment

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

It's a minor thing for now, but for the future do we want to keep the term "reference" in the navigation title?

@lcawl @alaudazzi
Update docs/source/reference-overview/kibana-reference.md
597ffa7 
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
@lcawl lcawl closed this Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alaudazzi alaudazzi alaudazzi approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@lcawl @alaudazzi