Converts logging README format to be compatible with new docs system #91958
Conversation
TinaHeiligers
added
docs
Feature:Logging
Team:Core
TinaHeiligers
changed the title
TinaHeiligers
changed the title
|
Pinging @elastic/kibana-core (Team:Core) |
|
Pinging @elastic/kibana-docs (Team:Docs) |
There was a problem hiding this comment.
Self review
There isn't a launch date yet for the new docs system. In our existing docs, we link to the logging README from the dev docs that means we need to be careful about how much we break up or change the current logging README.
Github renders .mdx files in a reasonably 'pretty' way, so for now I've gone with changing the readme to .mdx format without any extra editing (besides the syntax needed for the new docs system)
TinaHeiligers
added
the
release_note:skip
There was a problem hiding this comment.
My main question so far is what to do about the custom components the docs system uses. Since github doesn't render those at all, perhaps we should wait to make those updates until the new docs system is live, otherwise folks visiting the README on github will get a broken experience. WDYT?
I guess what I'm asking is, should we just convert this file to .mdx for now without doing anything else, until such a time as users are actually reading it on the "real" docs site?
| @@ -69,19 +69,19 @@ We will continue to focus on adding clarity around these types of services and w | |||
| ### Core services | |||
|
|
|||
| Sometimes referred to just as Core, Core services provide the most basic and fundamental tools neccessary for building a plugin, like creating saved objects, | |||
| routing, application registration, and notifications. The Core platform is not a plugin itself, although | |||
| routing, application registration, notifications and <DocLink id="kibCoreLogging" text="logging"/>. The Core platform is not a plugin itself, although | |||
There was a problem hiding this comment.
AFAIK, this doc is only used in the new Docs system, so linking to the kibCoreLogging section should be ok but please correct me if I'm wrong.
The other changes are all white-space changes for some reason.
|
@elasticmachine merge upstream |
The team has decided that's the way to go. |
TinaHeiligers
added
the
auto-backport
|
@lukeelmers Could you please take another quick glance at the doc changes please? I've changed links back to Github-friendly rendering links. |
| id: kibCoreLogging | ||
| slug: /kibana-dev-docs/services/logging | ||
| title: Logging system | ||
| image: https://source.unsplash.com/400x175/?Logging |
There was a problem hiding this comment.
I assume the unsplash images are just a placeholder thing? I noticed these in a few other docs from the new system but don't see those images surfaced anywhere.
There was a problem hiding this comment.
They're a placeholder and are optional at this point. I added it simply to follow what I also saw was being done in other docs.
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
…lastic#91958) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Partially addresses #57502
Converts
src/core/server/logging/README.mdtosrc/core/server/logging/README.mdxand updates the syntax to support mdx in the new docs system.There is a related PR (https://github.com/elastic/elastic-docs/pull/266) in the new docs system to have the logging service appear in the nav.