dockstore-ui2 icon indicating copy to clipboard operation
dockstore-ui2 copied to clipboard

update and add warning for Linux

Open denis-yuen opened this issue 2 years ago • 7 comments

Description Add warning against the use of Docker Desktop with Dockstore CLI

Review Instructions See that the warning appears in the quick-start

Issue https://github.com/dockstore/dockstore/issues/5135

Please make sure that you've checked the following before submitting your pull request. Thanks!

  • [x] Check that your code compiles by running npm run build
  • [x] If this is the first time you're submitting a PR or even if you just need a refresher, consider reviewing our style guide
  • [x] Do not bypass Angular sanitization (bypassSecurityTrustHtml, etc.), or justify why you need to do so
  • [x] If displaying markdown, use the markdown-wrapper component, which does extra sanitization
  • [x] Do not use cookies, although this may change in the future
  • [x] Run npm audit and ensure you are not introducing new vulnerabilities
  • [x] Do due diligence on new 3rd party libraries, checking for CVEs
  • [x] Don't allow user-uploaded images to be served from the Dockstore domain
  • [x] If this PR is for a user-facing feature, create and link a documentation ticket for this feature (usually in the same milestone as the linked issue). Style points if you create a documentation PR directly and link that instead.

denis-yuen avatar Nov 29 '22 23:11 denis-yuen

Screenshot from 2022-11-29 18-09-07

denis-yuen avatar Nov 29 '22 23:11 denis-yuen

Think build failure is a false positive

denis-yuen avatar Nov 30 '22 18:11 denis-yuen

Do we want to continue telling Mac users to install Docker Desktop? That is what I use without issue, but there's two orange flags here:

aofarrel avatar Nov 30 '22 20:11 aofarrel

Hmmm, added an additional comment in the documentation PR, but from https://github.com/dockstore/dockstore/issues/5135 I think I would recommend against Docker Desktop for Linux. I have little experience with Mac, but my understanding is Mac users do not have a choice?

denis-yuen avatar Nov 30 '22 20:11 denis-yuen

Hmmm, added an additional comment in the documentation PR, but from dockstore/dockstore#5135 I think I would recommend against Docker Desktop for Linux. I have little experience with Mac, but my understanding is Mac users do not have a choice?

It looks like there are some unofficial workarounds for not installing Docker Desktop on a Mac, but they're not official. So yes, you basically have to install Desktop.

Also, FWIW, my understanding is that the Docker Engine on Mac requires a VM as well... This link is old, but presumably still applicable: https://dev.to/ericnograles/why-is-docker-on-macos-so-much-worse-than-linux-flh

coverbeck avatar Nov 30 '22 22:11 coverbeck

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

sonarqubecloud[bot] avatar Dec 01 '22 15:12 sonarqubecloud[bot]

Codecov Report

Base: 43.22% // Head: 43.23% // Increases project coverage by +0.01% :tada:

Coverage data is based on head (9fd076c) compared to base (4be31c8). Patch has no changes to coverable lines.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1652      +/-   ##
===========================================
+ Coverage    43.22%   43.23%   +0.01%     
===========================================
  Files          314      314              
  Lines         9692     9692              
  Branches      2468     2468              
===========================================
+ Hits          4189     4190       +1     
  Misses        3453     3453              
+ Partials      2050     2049       -1     
Impacted Files Coverage Δ
...g/downloadcliclient/downloadcliclient.component.ts 56.25% <ø> (ø)
...ernal/change-username/change-username.component.ts 47.72% <0.00%> (ø)
...rc/app/home-page/home-logged-out/home.component.ts 67.56% <0.00%> (+2.70%) :arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Dec 01 '22 15:12 codecov[bot]