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] Adds breaking changes for 7.8 #68588

Merged
merged 6 commits into from
Jun 15, 2020

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Jun 8, 2020

Summary

This PR creates the breaking changes for 7.8.

This doc uses a new format for breaking changes, which includes collapsible sections. You can preview the new format here:

Preview
https://kibana_68588.docs-preview.app.elstc.co/guide/en/kibana/7.x/breaking-changes-7.8.html

To compare this format with previous versions of breaking changes, see the 7.7 breaking changes doc.

@gchaps gchaps added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v7.8.0 v7.9.0 labels Jun 8, 2020
@gchaps gchaps marked this pull request as ready for review June 10, 2020 17:49
@elasticmachine
Copy link
Contributor

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

Copy link
Contributor

@rayafratkina rayafratkina left a comment

Choose a reason for hiding this comment

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

I like the collapsed view for the plugin breaking changes section, but I think the end user section should be left expanded, so it's easier to see what changed at a glance.

====

[[breaking_78_bump_less_version]]
.The less version in TSVB was updated.
Copy link
Contributor

Choose a reason for hiding this comment

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

Less version updated in TSVB Markdown visualization



[[breaking_78_metrics_alerts]]
.Action messaging was refactored to report on the no data state.
Copy link
Contributor

Choose a reason for hiding this comment

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

Metrics alerts action messaging was refactored to report on the no data state.

=== Breaking changes for users

[[breaking_78_actions_api]]
.The actions API endpoint changed.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this belongs in the user-facing section. Confirming with Yulia and Bill.

Copy link
Contributor Author

@gchaps gchaps Jun 10, 2020

Choose a reason for hiding this comment

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

@YulNaumenko can you please comment on whether this content belongs in the user-facing section or the plugin developer section of the breaking changes doc? See here for a preview of the doc:

https://kibana_68588.docs-preview.app.elstc.co/guide/en/kibana/7.x/breaking-changes-7.8.html

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, it should be a plugin developer section of the breaking changes doc.

This fixes the Back button when navigating between dashboards using drilldowns.

*via {pull}62415[#62415]*
====
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks like a user facing breaking change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@streamich Can you please comment on whether this content should be moved to the user-facing section of the breaking changes doc? See here for a preview of the doc:

https://kibana_68588.docs-preview.app.elstc.co/guide/en/kibana/7.x/breaking-changes-7.8.html

Copy link
Contributor

Choose a reason for hiding this comment

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

To me it feels like (if it is a breaking change) it is, both, user and plugin developer facing breaking change. The change is basically that in a long Kibana URL like

http://kibana:5620/dashboard/xxx#...&panels={...}

The panels={ ... } variable is no longer present, like this

http://kibana:5620/dashboard/xxx#...

This change is technically in KibanaApp team's codebase, so I'll ping them to comment on how they see it: @timroes @ThomThomson @ppisljar

Copy link
Contributor

Choose a reason for hiding this comment

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

This seems to me like more of a user facing change because it affects view mode. I agree that it does apply to both plugin devs and users, but moving it up to the user facing section will give it a little bit more weight visually.

Copy link
Contributor

@rayafratkina rayafratkina left a comment

Choose a reason for hiding this comment

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

LGTM

@gchaps gchaps merged commit 8626b62 into elastic:7.x Jun 15, 2020
@gchaps gchaps deleted the docs/breaking-changes-7.8 branch June 15, 2020 21:08
gchaps added a commit to gchaps/kibana that referenced this pull request Jun 16, 2020
* [DOCS] Adds breaking changes for 7.8

* [DOCS] Adds more breaking changes

* [DOCS] Reformats breaking changes

* [DOCS] Incorporates edits

* [DOCS] Incorporates review comments

* [DOCS] Fixes links so they work in Install doc
gchaps added a commit that referenced this pull request Jun 16, 2020
* [DOCS] Adds breaking changes for 7.8

* [DOCS] Adds more breaking changes

* [DOCS] Reformats breaking changes

* [DOCS] Incorporates edits

* [DOCS] Incorporates review comments

* [DOCS] Fixes links so they work in Install doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.8.0 v7.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants