-
Notifications
You must be signed in to change notification settings - Fork 967
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
Add docs for tool panel and panel view administration #17078
Merged
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
mvdbeek
approved these changes
Nov 24, 2023
nsoranzo
reviewed
Nov 24, 2023
Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
nsoranzo
reviewed
Nov 24, 2023
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.
Great work!
Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
nsoranzo
approved these changes
Nov 27, 2023
Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
This PR was merged without a "kind/" label, please correct. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Tool panel administration was always mysterious to me. I have always wondered
integrated_tool_conf.xml
is what I often heard)I experimented a bit and added my experiences to the docs .. which were a bit outdated and in parts made statements about how things worked in the past (which was not so motivating read). For me, the main takeaways of my journey are: avoid touching any of
tool_conf.xml
,shed_tool_conf.xml
, andintegrated_tool_conf.xml
, but insteadtool_config_file
tool_conf.xml.sample
in thetool_config_file
configuration list (in this way built-in tools stay up to date)The changes also contain the first attempt to document the tool conf XML syntax.
Finally, I discovered the so far undocumented (besides the PR description) tool panel views and added the documentation here (mainly copy paste from the PR).
How to test the changes?
(Select all options that apply)
License