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

[Deprecations service] FAQ documentation #99043

Closed
wants to merge 1,307 commits into from

Conversation

Bamieh
Copy link
Member

@Bamieh Bamieh commented May 3, 2021

Adds a .mdx FAQ guide for deprecations service to help people getting started using it.

Note:

We've decided to add i18n to the deprecation config objects. First we need to inject i18n into the deprecation function to enable teams to use it before adding it to the docs and guideline. This will be done in a follow up PR with code changes. Related: #99072

src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

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

This looks great! Thanks for working on it @Bamieh. I left a few comments. Let me know if you have any questions.

src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
Copy link
Member

@tsullivan tsullivan left a comment

Choose a reason for hiding this comment

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

I left a few questions and a grammar suggestion.

src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
documentationUrl: 'elastic.co/some-url',
correctiveActions:{
manualSteps: [
`Replace "ui_metric.debug" with "usageCollection.uiCounters.debug" in the Kibana config file, CLI flag, or environment variable (in Docker only).`,
Copy link
Member

Choose a reason for hiding this comment

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

Should these messages be wrapped in an i18n function for translations?

Copy link
Member Author

Choose a reason for hiding this comment

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

We've had a discussion about this and i'm going to update the docs/faq to include i18n: #99072

src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Show resolved Hide resolved
nchaulet and others added 25 commits June 21, 2021 09:46
…01741)

* fix errors and update comments in Core

* fix errors or update comments in Security plugin

* update spaces test

* update task_manager files

* update comments in monitoring plugin

* fix errors in update comments in security_solutions

* fix errors and update comments in data_enhanced

* update fleet code

* update infra code

* update comment in trigger_actions_ui

* update comment in lens

* update comments in ES-UI code

* update typings for search

* update monitoring

* remove outdated export
This PR stabilizes the `setupModule` API tests by increasing the timeout for the jobs to finish.
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
* Add updated integrations subtitle

* Fix header image declarations

* Use theme hook for dark mode setting
…emplate (elastic#102677)

* Convert Engine Creation page to new page template

+ simplify EuiForm/form to 1 level of nesting

* Convert Meta Engine Creation page to new page template

* Initial conversion of Engines overview to new page template

* Engines Overview: simplify loading & empty state to use new page template props

* Engines Overview: simplify header

- now that the header/actions, chrome/telemetry, & empty state etc. are all DRY'd out by the template, there's no need for a separate header component
- we can simply dry out the header action, which will shortly be removed with the 7.14 launch

- note: for empty state changes: mostly indenting, the new template automatically creates a subdued panel for us in empty state so no need to include one manually

* Fix broken test mocks

I definitely should not have been importing the index file I'm mocking, but why did this only break now?? :psyduck:

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
One of the Workplace Search components was using the 'react-beautiful-dnd' typing for it’s component. This PR relpaces it with the EUI equivalent.
…ws (elastic#102680)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
* guard for null metrics query

* added some tests for the beat usage metric extraction function
* Updating audit terminology

* Fixing unit tests

* Updating audit docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
* Removing placeholder prerequisite section

* Removing placeholder defining-rules and rule-management

* Fixing links

* Setup to set up

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
* change telemetry banner dismiss location

* use dismissBanner method instead

* Update _metricbeat_dashboard.js

* Update _maps.ts

* Update _maps.ts

* Update _metricbeat_dashboard.js
* [Lens] Error on array values in math

* Update error messages

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
…age template (elastic#102679)

* Update routers

- To facilitate this being broken up into multiple PRs, non-migrated views still get a wrapping layout

* Set up Engine subnav in EuiSideNav format

+ tweak CSS for new label - heads up that this will break the old nav, but will disappear as the pages get converted

* Convert Engine Overview pages to new page template

* [PR feedback] Code comment explaining side nav icon reorder

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
* Fix add sample data layout

* remove useless change

* use KibanaPageTemplate

* use pageHeader for the header

* move tabs inside header

* tweaks

* fix imports
Bamieh and others added 2 commits June 27, 2021 15:23
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
@Bamieh Bamieh added docs auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v8.0.0 labels Jun 27, 2021
@Bamieh Bamieh marked this pull request as ready for review June 27, 2021 15:49
@Bamieh Bamieh requested review from a team and vigneshshanmugam as code owners June 27, 2021 15:49
@Bamieh Bamieh requested a review from a team June 27, 2021 15:49
@Bamieh Bamieh requested review from a team as code owners June 27, 2021 15:49
@Bamieh
Copy link
Member Author

Bamieh commented Jun 27, 2021

Sorry for the noise 😬 a bad rebase from my end caused this noise. Closing in favor of a fresh PR to avoid any extra team pings.

@Bamieh Bamieh closed this Jun 27, 2021
@Bamieh Bamieh deleted the deprecations/faq_guide branch June 27, 2021 15:51
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed docs release_note:skip Skip the PR/issue when compiling release notes test-docs v7.14.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.