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

Add docs for tool panel and panel view administration #17078

Merged
merged 5 commits into from
Nov 27, 2023

Conversation

bernt-matthias
Copy link
Contributor

Tool panel administration was always mysterious to me. I have always wondered

  • which XML files am I supposed to touch (in particular where to add custom tools)
  • how to obtain a useful ordering and add panels (modification of integrated_tool_conf.xml is what I often heard)
  • how to keep tool_conf.xml up to date during updates. So far I used a copy of the sample file where I added custom tools. Updating this copy with the releases is error-prone.

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, and integrated_tool_conf.xml, but instead

  • define section ordering and labels in an extra tool conf that is listed first in tool_config_file
  • directly include tool_conf.xml.sample in the tool_config_file configuration list (in this way built-in tools stay up to date)
  • add custom tools to extra tool conf files.

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)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
Copy link
Member

@nsoranzo nsoranzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
bernt-matthias and others added 2 commits November 24, 2023 16:53
Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
doc/source/admin/tool_panel.rst Outdated Show resolved Hide resolved
Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
@nsoranzo nsoranzo merged commit a3fd3b3 into galaxyproject:dev Nov 27, 2023
5 checks passed
Copy link

This PR was merged without a "kind/" label, please correct.

@bernt-matthias bernt-matthias deleted the topic/doc-panels branch November 27, 2023 14:49
@mvdbeek mvdbeek modified the milestones: 23.2, 24.0 Dec 19, 2023
@jdavcs jdavcs added the highlight/admin Included in admin/dev release notes label Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants