-
Notifications
You must be signed in to change notification settings - Fork 83
Document a new fleet_manager setting
#2727
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
Conversation
|
Do we need to update the Plugins page? |
renetapopova
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Just a minor suggestion.
| m|+++true+++ | ||
| |=== | ||
|
|
||
| == Fleet manager settings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should be the following to be consistent with the class in the monorepo:
| == Fleet manager settings | |
| == Fleet management settings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The official name of the feature changed to "Fleet manager", also, the setting has "manager" in its key. @SeBBBe, WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think "Fleet manager" is preferred as we've decided to rebrand the feature under that name. We also made a decision not to change the procedures, so those will still be under the fleetManagement name (in order not to have to force existing users to change their whitelisting settings etc), but we should move to the new name wherever it makes sense.
Co-authored-by: Reneta Popova <[email protected]>
Yeah, I think so. |
@alexnb, which details should we add to the page ⬆️? WDYT? |
Maybe extending the example in the code block at the end of the page ("# to enable Fleet management ..."). I guess it would be better if @SeBBBe reviews this PR, adding him. |
|
It will be possible to use fleet manager either by enabling the setting documented in this PR, or by installing the fleet manager plugin (which is the current method). The plan is to enable fleet manager by default some time in Q1, at which point the plugin documentation will be obsoleted for that Neo4j version, going forward. That means that when we do the launch of the off-by-default built-in fleet manager, we are in sort of an intermediate stage. For the Aura documentation and the copy shown in the Aura console, we've decided to keep the current copy intact (which is to install the plugin). After it's been enabled by default we'll change the copy. Otherwise we find that it becomes confusing. Does this approach make sense? |
I think it makes sense, and let's keep our docs (Aura docs and the Ops manual) consistent. If I understand correctly, at the moment there is no need for user to configure this setting, or even to know a lot about this setting. A user should follow the current steps. This will be less confusing |
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
Yes, that's correct! |
SeBBBe
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
No description provided.