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

[Docs] remove Kibana book-scoped attributes from 7.17 #178759

Merged
merged 7 commits into from
Mar 19, 2024

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented Mar 14, 2024

Summary

Removes book-scoped docs attributes from 7.17 in preparation for eventual migration to Docsmobile

backports changes from #178676 and #155210

  • some unused attributes were removed
  • attributes used on a single page were moved to that page
  • globally-defined attributes were removed:

note: looks like data-source and data-sources are not respecting the capitalization of the attribute so it's getting overridden by legacy attr. definitions, leading to a capitalization bug. prob should be fixed in the global attributes file

https://github.com/elastic/kibana/blob/7.17/docs/user/dashboard/dashboard.asciidoc?plain=1#L380
image

@shainaraskas shainaraskas added Team:Docs release_note:skip Skip the PR/issue when compiling release notes docs v7.17.19 labels Mar 14, 2024
@shainaraskas shainaraskas requested a review from a team March 14, 2024 17:20
@shainaraskas shainaraskas added the backport:skip This commit does not require backporting label Mar 14, 2024
@@ -6,7 +6,7 @@ We use functional tests to make sure the {kib} UI works as expected. It replaces
[discrete]
=== Running functional tests

The `FunctionalTestRunner` is very bare bones and gets most of its functionality from its config file, located at {blob}test/functional/config.js[test/functional/config.js] or {blob}x-pack/test/functional/config.js[x-pack/test/functional/config.js]. If you’re writing a plugin outside the {kib} repo, you will have your own config file.
The `FunctionalTestRunner` is very bare bones and gets most of its functionality from its config file. If you’re writing a plugin outside the {kib} repo, you will have your own config file.
Copy link
Contributor Author

@shainaraskas shainaraskas Mar 14, 2024

Choose a reason for hiding this comment

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

took out the links to match 8.14 because the links were dead - this file is referenced/linked to in the doc linked lower on the page

@@ -64,7 +64,8 @@ export default async function ({ readConfigFile }) {
}

// more settings, like timeouts, mochaOpts, etc are
// defined in the config schema. See {blob}src/functional_test_runner/lib/config/schema.js[src/functional_test_runner/lib/config/schema.js]
// defined in the config schema.
// See {kibana-blob}packages/kbn-test/src/functional_test_runner/lib/config/schema.ts
Copy link
Contributor Author

@shainaraskas shainaraskas Mar 14, 2024

Choose a reason for hiding this comment

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

@shainaraskas follow up on this path change. need to also port this change forward to main

file was moved here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Confirmed with the Kibana team that this new file is the correct replacement

@shainaraskas shainaraskas marked this pull request as ready for review March 18, 2024 14:35
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

@shainaraskas shainaraskas enabled auto-merge (squash) March 19, 2024 18:18
@lcawl
Copy link
Contributor

lcawl commented Mar 19, 2024

note: looks like data-source and data-sources are not respecting the capitalization of the attribute so it's getting overridden by legacy attr. definitions, leading to a capitalization bug. prob should be fixed in the global attributes file...

Fixed in elastic/docs#2963

@shainaraskas shainaraskas merged commit 5636a8e into elastic:7.17 Mar 19, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.17.19
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants