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

Basic documentation of CWL export feature #232

Merged
merged 1 commit into from
Jun 24, 2024
Merged

Basic documentation of CWL export feature #232

merged 1 commit into from
Jun 24, 2024

Conversation

mr-c
Copy link
Contributor

@mr-c mr-c commented Jun 21, 2024

User description

Describe the change

List CWL as a supported workflow language for OpenMS tools

PR checklist

image


image


image


PR Type

Documentation


Description

  • Added CWL as a supported workflow system in the installation and workflows documentation.
  • Created a new getting started guide for CWL, describing how to generate CWL tool descriptions using OpenMS tools.
  • Included CWL logo and links to the CWL getting started guide in relevant sections.

Changes walkthrough 📝

Relevant files
Documentation
installation.rst
Add CWL as a supported workflow system in installation docs

docs/about/installation.rst

  • Added CWL as a supported workflow system in the installation
    documentation.
  • Included CWL logo and link to CWL getting started guide.
  • +9/-2     
    cwl-get-started.md
    Create CWL getting started guide                                                 

    docs/getting-started/cwl-get-started.md

  • Created a new getting started guide for CWL.
  • Described how to generate CWL tool descriptions using OpenMS tools.
  • +10/-0   
    workflows.rst
    Add CWL to supported workflow systems in workflows docs   

    docs/getting-started/workflows.rst

  • Added CWL as a supported workflow system in the workflows
    documentation.
  • Included CWL logo and link to CWL getting started guide.
  • +21/-1   

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    This comment was marked as outdated.

    @mr-c mr-c force-pushed the cwl branch 5 times, most recently from 9109e45 to 6cdc1b8 Compare June 24, 2024 17:56
    @mr-c mr-c marked this pull request as ready for review June 24, 2024 18:10
    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 2 labels Jun 24, 2024
    Copy link
    Contributor

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 2
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review Redundant Content:
    The description of CWL support is repeated in the workflows.rst file for both light and dark themes. Consider merging them into a single entry with a conditional theme check if possible.
    Image Sizing:
    Ensure that the image sizes and alignments are consistent across all workflow system logos to maintain a uniform appearance.

    This comment was marked as off-topic.

    @timosachsenberg timosachsenberg merged commit 8592dc3 into develop Jun 24, 2024
    1 check passed
    @mr-c mr-c deleted the cwl branch June 24, 2024 18:25
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants