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

Serverless documentation links #2297

Open
lcawl opened this issue Sep 27, 2023 · 1 comment
Open

Serverless documentation links #2297

lcawl opened this issue Sep 27, 2023 · 1 comment
Assignees

Comments

@lcawl
Copy link
Contributor

lcawl commented Sep 27, 2023

🚀 Feature Proposal

In order to have documentation links that are appropriate for Serverless, I believe we need a second serverless-specific file like https://github.com/elastic/elasticsearch-specification/blob/main/specification/_doc_ids/table.csv

The URLs for serverless documentation will be significantly different than the URLs for the classic docs. Though we don't have all of the content created yet, writers can start filling in the new list for the pages that already exist.

Then when we generate the output specification files we just need the tools (or some manual method) to ensure that we can pull in the appropriate table.csv file.

Related:

Motivation

We need our specifications to point to the appropriate set of documentation.

Example

For example, the page https://www.elastic.co/guide/en/elasticsearch/reference/master/search-aggregations.html in the classic docs is https://docs-staging.elastic.dev/serverless/elasticsearch/explore-your-data-aggregations in the serverless (WIP) docs.

@swallez
Copy link
Member

swallez commented Sep 27, 2023

Thanks @lcawl. That makes sense to have a separate file for serverless doc URLs (e.g. table_serverless.csv).

The next step for the client team will be to update the schema.json format to allow for both URLs to be imported there, and also update the various generation pipelines to take it into account.

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

No branches or pull requests

2 participants