marquez icon indicating copy to clipboard operation
marquez copied to clipboard

Add guidance to the main README and the Docs for Windows users

Open merobi-hub opened this issue 11 months ago • 2 comments

Problem

Windows users sometimes encounter issues when trying to get started with Marquez. Fortunately, this is not due to any of the scripts in docker. A slightly different command is required to run the up script, however. Also, judging from errors reported in Slack, some Windows users are not aware of the Postgres requirement or do not have it or Bash installed and in PATH.

Solution

This adds additional guidance to the Docs and main README for Windows users. Tested on a development version of Windows 11 Pro.

Also included: miscellaneous style fixes and an update to the compatibility table.

Note: All database schema changes require discussion. Please link the issue for context.

One-line summary: adds guidance for Windows users

Checklist

  • [x] You've signed-off your work
  • [ ] Your changes are accompanied by tests (if relevant)
  • [x] Your change contains a small diff and is self-contained
  • [ ] You've updated any relevant documentation (if relevant)
  • [x] You've included a one-line summary of your change for the CHANGELOG.md (Depending on the change, this may not be necessary).
  • [ ] You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)
  • [ ] You've included a header in any source code files (if relevant)

Firefox_Screenshot_2024-03-24T13-13-52 302Z

Firefox_Screenshot_2024-03-24T17-31-27 120Z

merobi-hub avatar Mar 24 '24 04:03 merobi-hub

Deploy Preview for peppy-sprite-186812 ready!

Name Link
Latest commit fd7a0f287850a407ab4428eaf72716170741ad2b
Latest deploy log https://app.netlify.com/sites/peppy-sprite-186812/deploys/664bab89be70b20008a26f1e
Deploy Preview https://deploy-preview-2777--peppy-sprite-186812.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Mar 24 '24 04:03 netlify[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.57%. Comparing base (8e448ce) to head (fd7a0f2).

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #2777   +/-   ##
=========================================
  Coverage     84.57%   84.57%           
  Complexity     1441     1441           
=========================================
  Files           251      251           
  Lines          6503     6503           
  Branches        302      302           
=========================================
  Hits           5500     5500           
  Misses          850      850           
  Partials        153      153           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Mar 24 '24 04:03 codecov[bot]