Skip to content

Conversation

@pebrc
Copy link
Collaborator

@pebrc pebrc commented Feb 28, 2025

Part of #8498

https://docs-v3-preview.elastic.dev/elastic/cloud-on-k8s/pull/8501/reference/

Adjust the templating for the API reference. Markdown was modelled after #8496

Differences to the manually migrated files: API reference tool creates a single file not a file per group, we could however adjust that if needed.

@pebrc pebrc added the >docs Documentation label Feb 28, 2025
Copy link
Contributor

@barkbay barkbay left a comment

Choose a reason for hiding this comment

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

LGTM

---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-api-reference.html
navigation_title: API reference
Copy link
Contributor

Choose a reason for hiding this comment

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

nit, for consistency?

Suggested change
navigation_title: API reference
navigation_title: API Reference

(not 100% sure)

@eedugon
Copy link
Contributor

eedugon commented Mar 3, 2025

@pebrc :

Differences to the manually migrated files: API reference tool creates a single file not a file per group, we could however adjust that if needed.

I believe that's totally up to you to decide.

In the asciidoc system (here) they appear to be separate documents, that's why our automatic migration created different markdown files for each item.

If you think it's better to show all the content in the same page (like k8s api docs) I'm almost sure that's totally fine.

@pebrc
Copy link
Collaborator Author

pebrc commented Mar 3, 2025

@pebrc :

Differences to the manually migrated files: API reference tool creates a single file not a file per group, we could however adjust that if needed.

I believe that's totally up to you to decide.

In the asciidoc system (here) they appear to be separate documents, that's why our automatic migration created different markdown files for each item.

If you think it's better to show all the content in the same page (like k8s api docs) I'm almost sure that's totally fine.

I spent a bit more time on breaking up the single file. The tooling we have makes it hard to generate the grouping into files the way the migration has created them. I think I stick with a single file if that's OK for now. If we have more time to optimise this later we can think about breaking it up into single files per API kind.

@pebrc pebrc merged commit 5f819fd into elastic:main Mar 3, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants