#5561: Add documentation for all plugins #6084
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
MV88
requested changes
Oct 23, 2020
web/client/plugins/BurgerMenu.jsx
Outdated
| * Menu button that can contain other plugins entries. | ||
| * Usually rendered inside {@link #plugins.OmniBar|plugins.OmniBar} | ||
| * You can render an item inside burger menu by adding the following to the `containers` entry of your plugin. | ||
| * It is a wrapper for `ToolsContainer` so all the properties of the tools of {@ plugins.containers.ToolContainer|ToolContainer} can be used here (action, selector ...). |
There was a problem hiding this comment.
wrong link{@ plugins.containers.ToolContainer|ToolContainer}
There was a problem hiding this comment.
in toolContainer can we move the examples below ?
Co-authored-by: Matteo V. <matteo.velludini.geosolutions@gmail.com>
|
@MV88 thank you very much for your comments, they are very useful. |
MV88
approved these changes
Oct 26, 2020
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.
Description
All the missing plugins has been documented and added to the main docma-config. Also all the missing pages are documented.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (check one with "x", remove the others)
link to doc can not be provided because JSDoc is hosted on mapstore. To check it run
npm run doctestandnpm startIssue
What is the current behavior?
#5561
What is the new behavior?
Breaking change
Does this PR introduce a breaking change? (check one with "x", remove the other)
Other useful information
Note: at the moment the context creator links to mapstore.geo-solutions.it, and this doc is instead deployed on dev.