Skip to content

[Feature Request]: Better URLs for reference content to avoid collisions #672

@shainaraskas

Description

@shainaraskas

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

Because we generate URLs based on their repo locations, our release note + reference URLs look like this:

https://docs-v3-preview.elastic.dev/elastic/kibana/tree/main/reference/configuration-reference
https://docs-v3-preview.elastic.dev/elastic/elasticsearch/tree/main/release-notes/known-issues

because /elastic/kibana/tree/main / /elastic/elasticsearch/tree/main is part of the preview path and not the final path, we have these two paths:

/reference/configuration-reference (unclear this page is kibana specific)
/release-notes/known-issues (unclear this page is es specific)

in the second example, in a system with all of the different repos assembled, we'd get conflicts for a page called known issues. We'll also likely run into other conflicts we can't predict.

We need some way of injecting the product name into these paths.

Proposed Solution

Some way to inject an identifier per repo (maybe in the docset yml?)

Examples and Research

No response

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Critical

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions