docs/multiplexing: overhaul plugin documentation #14509
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fairclothjm
force-pushed
the
docs/vault-3570/plugin-multiplexing
branch
from
126e0b0 to
a136fed
Compare
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
| There is only one step required to upgrade from a non-multiplexed to a | ||
| multiplexed database plugin: | ||
|
|
||
| 1. Change the `Serve` function call to `ServeMultiplex`. |
There was a problem hiding this comment.
Since it's just one step, no need to include a numbered step here.
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
reviewed
Mar 22, 2022
taoism4504
approved these changes
Mar 22, 2022
Co-authored-by: Loann Le <[email protected]>
calvn
approved these changes
Mar 22, 2022
fairclothjm
added a commit
that referenced
this pull request
Mar 22, 2022
* docs/multiplexing: overhaul plugin documentation * update nav data * remove dupe nav data * add external plugin section to index * move custom plugin backends under internals/plugins * remove ref to moved page * revert moving custom plugin backends * add building plugins from source section to plug dev * add mux section to plugin arch * add mux section to custom plugin page * reorder custom database page * use 'external plugin' where appropriate * add link to plugin multiplexing * fix example serve multiplex func call * address review comments * address review comments * Minor format updates (#14590) * mv Plugins to top-level; update upgrading plugins * update links after changing paths * add section on external plugin scaling characteristics * add updates on plugin registration in plugin management page * add plugin learn resource * be more explicit about mux upgrade steps; add notes on when to avoid db muxing * add plugin upgrade built-in section * add caveats to built-in plugin upgrade * improvements to built-in plugin override * formatting, add redirects, correct multiplexing use case * fix go-plugin link * Apply suggestions from code review Co-authored-by: Loann Le <[email protected]> * remove single item list; add link to Database interface Co-authored-by: Yoko Hyakuna <[email protected]> Co-authored-by: Loann Le <[email protected]>
fairclothjm
added a commit
that referenced
this pull request
Mar 22, 2022
* docs/multiplexing: overhaul plugin documentation * update nav data * remove dupe nav data * add external plugin section to index * move custom plugin backends under internals/plugins * remove ref to moved page * revert moving custom plugin backends * add building plugins from source section to plug dev * add mux section to plugin arch * add mux section to custom plugin page * reorder custom database page * use 'external plugin' where appropriate * add link to plugin multiplexing * fix example serve multiplex func call * address review comments * address review comments * Minor format updates (#14590) * mv Plugins to top-level; update upgrading plugins * update links after changing paths * add section on external plugin scaling characteristics * add updates on plugin registration in plugin management page * add plugin learn resource * be more explicit about mux upgrade steps; add notes on when to avoid db muxing * add plugin upgrade built-in section * add caveats to built-in plugin upgrade * improvements to built-in plugin override * formatting, add redirects, correct multiplexing use case * fix go-plugin link * Apply suggestions from code review Co-authored-by: Loann Le <[email protected]> * remove single item list; add link to Database interface Co-authored-by: Yoko Hyakuna <[email protected]> Co-authored-by: Loann Le <[email protected]> Co-authored-by: Yoko Hyakuna <[email protected]> Co-authored-by: Loann Le <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rework some of the plugin documentation and add details on database plugin multiplexing feature.
The Plugins page has been moved as a top-level directory. It has been broken into Overview, Plugin Architecture and Plugin Development. The Plugin Portal has been moved to live under the top-level Plugin directory. The Plugin Backends page has been renamed to Plugin Management and moved under the top-level Plugin directory.
🔍 Deploy Preview