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

[DOCS] Add placeholders for Observability docs #1216

Merged
merged 2 commits into from
Jun 29, 2020

Conversation

EamonnTP
Copy link
Contributor

This PR adds content placeholders for the forthcoming Observability docs. This directory and the files will be included in the migration of the Logs and Metrics directories to the new Observability repo.

The following PRs need to be merged before migrating the Logs and Metrics directories:

#1210
#1203

Related PRs:

elastic/docs#1877

++++
<titleabbrev>What is Elastic Observability?</titleabbrev>
++++
== What is Elastic Observability?
Copy link
Contributor

Choose a reason for hiding this comment

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

I know this is all placeholder stuff, but we should start thinking about how we want to structure the content.

1 - We definitely want a one to one mapping between topics and HTML output. So one asciidoc file = one HTML file.

2 - To control TOC nesting, we should explore using level offsets. I've done this in the ingest management docs with mixed success. (The strategy worked for +1 and +2 offsets, but broke for anything nested more deeply.) We should follow up with other teams to see if they've had more success, but I think it's the best way forward to make it easier to decouple TOC/navigation from heading levels.

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Neat! I agree with DeDe that we should start having conversations about a consistent structure for the Observability content.

I'm say we merge this as-is and update the structure when the actual content is added to this book.

@bmorelli25
Copy link
Member

bmorelli25 commented Jun 29, 2020

Small note: I'd also like to see us remove the unnecessary /en/ directory in our docs.

Edit: Maybe even /docs/en/? Something else to chat about.

@dedemorton
Copy link
Contributor

Let's bring up the question about /docs/en/ with other writers in the org. Eventually we will need language-specific folders for translation.

@bmorelli25
Copy link
Member

Ahh, I didn't realize that was still something we were planning on doing.

@EamonnTP EamonnTP merged commit 92786f5 into elastic:master Jun 29, 2020
@EamonnTP EamonnTP deleted the add-observability-docs branch June 29, 2020 19:28
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.

3 participants