dockstore / dockstore

Our VM/Docker sharing infrastructure and management component
https://dockstore.org/
Apache License 2.0
116 stars 27 forks source link

Make github-landing-page example .dockstore.yml copyable #5904

Closed david4096 closed 1 day ago

david4096 commented 3 weeks ago

Is your feature request related to a problem? Please describe.

Tried to use the example .dockstore.yml on the GitHub landing page and the indentation made it difficult. There is one level of indentation added to every line

image

Describe the solution you'd like

The editor text should be more readily usable by removing the indentation.

Describe alternatives you've considered

n/a

Additional context

Came up during prep for presentation for WDL bootcamp

┆Issue is synchronized with this Jira Story ┆Attachments: Screenshot 2024-06-24 at 2.39.28 PM.png ┆Fix Versions: Dockstore 1.15.x ┆Issue Number: DOCK-2532 ┆Sprint: 139 - Lothal ┆Issue Type: Story

denis-yuen commented 3 weeks ago

Probably better than https://ucsc-cgl.atlassian.net/browse/SEAB-6486 (should be public), can close when jira is back up

unito-bot commented 2 weeks ago

➤ Denis Yuen commented:

Note, this is fixed in qa. Probably parts need to be copied/cherry-picked to hotfix

david4096 commented 2 weeks ago

Noting that the new code cell fixes the indentation problem but that the version field is not copyable. The comment on the schema line causes the parsing to fail I believe.

image

I removed it and was able to successfully push

image

denis-yuen commented 2 weeks ago

Hmmm, I'd think that would be a bug in the parsing code rather than an issue with the landing page.

circleci yaml has a ton of this https://github.com/dockstore/dockstore/blob/develop/.circleci/config.yml and as separated comments 6.9 https://yaml.org/spec/1.2.2/#66-comments

unito-bot commented 4 days ago

➤ Charles Overbeck commented:

Reviewer should review in staging or prod, not in QA.

denis-yuen commented 4 days ago

(attempted fix as part of merge of hotfix 2.12.3)

unito-bot commented 1 day ago

➤ David Steinberg commented:

Looks good

!Screenshot 2024-06-24 at 2.39.28 PM.png|width=708,height=409,alt="Screenshot 2024-06-24 at 2.39.28 PM.png"!

[Domain] - https://staging.dockstore.org ( https://staging.dockstore.org )

Webservice ( https://github.com/dockstore/dockstore/releases/tag/1.15.3 ) - 1.15.3

UI ( https://github.com/dockstore/dockstore-ui2/releases/tag/2.12.3 ) - 2.12.3

Deploy ( https://github.com/dockstore/dockstore-deploy/releases/tag/1.15.0-rc.1 ) - 1.15.0-rc.1