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] Deprecate central management #14104

Merged
merged 2 commits into from
Nov 18, 2019
Merged

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Oct 16, 2019

Closes #14045. Adds deprecation statement to the topics about central management. Also removes docs that points users to central management because I don't think we should be directing users to use a feature that's not deprecated. We will replace the references when docs for our CM replacement are in place.

TODO:

@dedemorton dedemorton added docs review needs_backport PR is waiting to be backported to other branches. v7.5.0 labels Oct 16, 2019
@mattapperson
Copy link

@dedemorton I am not sure we want to state it is deprecated as of 7.5. Technically it has been deprecated, we are just being more upfront about it now

@dedemorton
Copy link
Contributor Author

@mattapperson I wonder if we should say "discontinued" instead of "deprecated." I'm not sure how we've handled this in the past. It would be nice to have some standard text that we can provide when we decide to discontinue a beta feature. @debadair Does the Elasticsearch team have a convention for flagging beta features that are discontinued?

@debadair
Copy link
Contributor

debadair commented Oct 17, 2019

I think discontinued is the right term to use here. Elasticsearch follows a specific process for marking existing (GA) features as deprecated and ultimately removing them. I didn't find any examples in ES, but we used discontinued for an ES Hadoop beta feature that was removed:

YARN Integration Discontinued
Due to the limitations in YARN for support of long running processes, we have decided to cease development and discontinue the YARN integration in ES-Hadoop. We thank the community for participating in the beta. If you have any questions or concerns about this, please feel free to discuss them on our forums.

We don't have a built-in widget for this like deprecated. Maybe format it as a sidebar?

.Beats central management discontinued
**** 
We have ceased development on Beats central management and 
are working on a comprehensive solution to replace it. 
Thank you for participating in the beta and providing feedback. 
If you have any questions or concerns, please reach out to us on the
https://discuss.elastic.co/c/beats[Discuss forum].
****

I'm generally not a fan of "please" and "thank you" in the docs, but this is a case where it probably makes sense.

Whatever you decide to do, it would be good to "templify" it and put it in the docs/shared folder.

@dedemorton
Copy link
Contributor Author

dedemorton commented Oct 17, 2019

@mattapperson I like Deb's suggestion. If it looks good to you, I will change the text accordingly.

@ph
Copy link
Contributor

ph commented Oct 22, 2019

look OK on my side @dedemorton and @debadair

@mattapperson
Copy link

@dedemorton yup, looks good to me

@dedemorton
Copy link
Contributor Author

I added a statement to the docs repo that we can include in any books that mention Central management: elastic/docs#1354

@dedemorton
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@dedemorton
Copy link
Contributor Author

jenkins test this please

@dedemorton
Copy link
Contributor Author

travis-ci is incorrectly reporting an error. Since this PR passes the doc check under beats-ci and elasticsearch-ci/docs, I'm merging.

@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Nov 18, 2019
dedemorton added a commit to dedemorton/beats that referenced this pull request Nov 19, 2019
ycombinator added a commit that referenced this pull request Nov 19, 2019
* Log monitoring bulk failures (#14356)

* Log monitoring bulk failures

* Renaming function

* Simplifying type

* Removing extraneous second value

* Adding godoc comments

* Adding CHANGELOG entry

* Clarifying log messages

* WIP: adding unit test stubs

* Fleshing out unit tests

* [DOCS] Deprecate central management (#14104) (#14594)

* State minimum Go version (#14400) (#14598)

* [DOCS] Fix description of rename processor (#14408) (#14600)

* Log monitoring bulk failures (#14356)

* Log monitoring bulk failures

* Renaming function

* Simplifying type

* Removing extraneous second value

* Adding godoc comments

* Adding CHANGELOG entry

* Clarifying log messages

* WIP: adding unit test stubs

* Fleshing out unit tests

* Fixing up CHANGELOG
@andresrc andresrc added the Team:Integrations Label for the Integrations team label Mar 6, 2020
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
* Log monitoring bulk failures (elastic#14356)

* Log monitoring bulk failures

* Renaming function

* Simplifying type

* Removing extraneous second value

* Adding godoc comments

* Adding CHANGELOG entry

* Clarifying log messages

* WIP: adding unit test stubs

* Fleshing out unit tests

* [DOCS] Deprecate central management (elastic#14104) (elastic#14594)

* State minimum Go version (elastic#14400) (elastic#14598)

* [DOCS] Fix description of rename processor (elastic#14408) (elastic#14600)

* Log monitoring bulk failures (elastic#14356)

* Log monitoring bulk failures

* Renaming function

* Simplifying type

* Removing extraneous second value

* Adding godoc comments

* Adding CHANGELOG entry

* Clarifying log messages

* WIP: adding unit test stubs

* Fleshing out unit tests

* Fixing up CHANGELOG
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs review Team:Integrations Label for the Integrations team v7.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate Beats central management docs
6 participants