Skip to content

Improve markdown editor modularity and structure#19835

Merged
guerler merged 39 commits intogalaxyproject:devfrom
guerler:markdown_editor.000
Mar 19, 2025
Merged

Improve markdown editor modularity and structure#19835
guerler merged 39 commits intogalaxyproject:devfrom
guerler:markdown_editor.000

Conversation

@guerler
Copy link
Copy Markdown
Contributor

@guerler guerler commented Mar 18, 2025

Extracted from #19775. This PR contains various improvements to the markdown editor:

  1. Migrate Markdown templates and requirements from JSON to YAML.
  2. Ensure consistent parsing and handling of workflow labels.
  3. Upgrade visualization packages to the latest versions.
  4. Change the default setting for markdown-compatible/embeddable visualizations in the visualization XML from true to false. Developers must now explicitly enable this option for visualizations to appear in the markdown toolbox, preventing unintended listings due to a missing setting.
  5. Contains a fix for the Vega wrapper fixing the reactivity
  6. Various minor fixes for Markdown components and additional tests
  7. Adjust layout of final Markdown display page, fixes wrong update time, add margin to allow scrolling (without it users might get stuck zooming into visualizations instead)

Before:
image

After:
image

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.

guerler added 27 commits March 18, 2025 10:39
@guerler guerler added area/UI-UX kind/refactoring cleanup or refactoring of existing code, no functional changes labels Mar 18, 2025
@guerler guerler added this to the 25.0 milestone Mar 18, 2025
@guerler guerler marked this pull request as ready for review March 18, 2025 16:46
@guerler guerler requested a review from davelopez March 18, 2025 18:32
Copy link
Copy Markdown
Contributor

@davelopez davelopez left a comment

Choose a reason for hiding this comment

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

The refactoring looks good to me. Some very minor comments below.


export interface WorkflowLabel {
label: string;
type: "input" | "output" | "step";
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've seen this type re-defined in several places (WorkflowLabelKind), it would be nice to have a single type definition in a common place as a single source of truth.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thank you, I will consolidate these in a follow-up.

Comment thread client/src/components/Markdown/Utilities/parseInvocation.ts Outdated
Comment thread client/src/components/Markdown/MarkdownDialog.vue Outdated
guerler and others added 2 commits March 19, 2025 12:05
Co-authored-by: David López <46503462+davelopez@users.noreply.github.com>
Co-authored-by: David López <46503462+davelopez@users.noreply.github.com>
@guerler guerler merged commit 7ff91d8 into galaxyproject:dev Mar 19, 2025
51 of 56 checks passed
@guerler guerler deleted the markdown_editor.000 branch March 19, 2025 17:45
@guerler
Copy link
Copy Markdown
Contributor Author

guerler commented Mar 19, 2025

@davelopez thank you so much for the review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/UI-UX kind/enhancement kind/refactoring cleanup or refactoring of existing code, no functional changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants