conda / conda-lock

Lightweight lockfile for conda environments
https://conda.github.io/conda-lock/
Other
470 stars 102 forks source link

Add a guide/walkthrough #355

Open jesshart opened 1 year ago

jesshart commented 1 year ago

Description

This is the draft walkthrough I mentioned on issue #350.

netlify[bot] commented 1 year ago

Deploy Preview for conda-lock ready!

Name Link
Latest commit f4476c5037d35fcea30f77b8964f460725ef8d65
Latest deploy log https://app.netlify.com/sites/conda-lock/deploys/641ca27597ccc300077de3e4
Deploy Preview https://deploy-preview-355--conda-lock.netlify.app/walkthrough
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 settings.

maresb commented 1 year ago

Thanks a lot for this!!! Quickly skimming I really like the concept. I could see this turning into some sort of quickstart guide. I think people will have a substantial amount of feedback and suggestions, but working through those may be very valuable for bridging the gap between new and experienced users.

I am also not sure if/how exactly we will publish this. That is dependent on how this evolves, and also a broader consensus among the maintainers, so I can't make any promises. Also, our review capacity is a bit strained at the moment, so I really hope that spectators step up and offer their feedback.

Thanks a lot for all the careful work and thought you have put into this!

maresb commented 1 year ago

You should probably get pre-commit running locally on your side, it is simpler than pytest.

maresb commented 1 year ago

pre-commit.ci autofix

maresb commented 1 year ago

Make sure to pull that pre-commit formatting fix before making additional commits in order to prevent merge conflicts.

jesshart commented 1 year ago

Document Changes

jesshart commented 1 year ago

@maresb I updated the document per the conversations here. However, I forgot to follow your instructions,

Make sure to pull that pre-commit formatting fix before making additional commits in order to prevent merge conflicts.

Which may have caused a problem. I resolved the merge conflicts on my end, but it looks like they still broke during the pre-commit.ci - pr step. Do I need to do anything on my end?

maresb commented 1 year ago

@jesshart, if you like your local version, then the easiest solution is to do a force-push git push --force and this will replace the conflicting walkthrough-doc branch here with your local copy.

mariusvniekerk commented 1 year ago

pre-commit.ci autofix