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

Remove duplicate data view attributes #2963

Merged
merged 2 commits into from
Mar 20, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 18, 2024

Relates to #2778, elastic/kibana#178759

Per https://docs.asciidoctor.org/asciidoc/latest/attributes/names-and-values/ "Although uppercase characters are permitted in an attribute name, the name is converted to lowercase before being stored. For example, URL-REPO and URL-Repo are treated as url-repo when a document is loaded or converted. A best practice is to only use lowercase letters in the name and avoid starting the name with a number". Therefore the "legacy" attributes like Data-Sources are considered to be the same as data-sources and since the former appears later in the attributes file, its value is used in pages such as:

https://www.elastic.co/guide/en/kibana/current/introduction.html

image

https://www.elastic.co/guide/en/kibana/current/dashboard.html

image

This PR therefore removes the problematic case-sensitive attribute names.

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@lcawl lcawl marked this pull request as ready for review March 19, 2024 15:20
@lcawl lcawl requested a review from a team as a code owner March 19, 2024 15:20
joepeeples
joepeeples previously approved these changes Mar 19, 2024
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Thanks for opening the PR, @lcawl! I had the same thing on my back burner in #2934 but never fully opened it (got distracted by EAH then 8.13 release).

I added a question about whether we should keep :A-data-source: and :a-data-source: since they're also duplicates, but will give this an approval to speed things along if no further changes are needed.

shared/attributes.asciidoc Outdated Show resolved Hide resolved
@joepeeples
Copy link
Contributor

joepeeples commented Mar 19, 2024

Oh, one other thing: we still have the equivalent case-sensitive variables in the serverless docs at docs.elastic.co.

  "Data-Sources": "Data Views",
  "Data-source": "Data view",
  "data-source": "data view",
  "Data-sources": "Data views",
  "data-sources": "data views",
  "data-source-caps": "Data View",
  "data-sources-caps": "Data Views",
  "data-source-cap": "Data view",
  "data-sources-cap": "Data views",
  "A-data-source": "A data view",
  "a-data-source": "a data view",

They aren't causing trouble like the AsciiDoc attributes are, but we should probably remove them since they're legacy variables that we don't want to encourage anyone to use. Again, I have a draft PR for that, we can clean it up and open it if you want to use that: https://github.com/elastic/docs.elastic.co/pull/205

Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

LGTM! I also updated https://github.com/elastic/docs.elastic.co/pull/205 to keep a-data-source in case it's needed on the serverless/Docsmobile side.

@lcawl lcawl merged commit e6b9758 into elastic:master Mar 20, 2024
3 checks passed
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.

2 participants