fides icon indicating copy to clipboard operation
fides copied to clipboard

Published 20 hours ago • verified publisher icon ethyca

Fix shell command in README quickstart

Open sanders41 opened this issue 2 years ago • 3 comments

Closes #1411

Code Changes

  • [x] Changed the nox command from nox -s dev to nox -s dev -- shell in the README quick start.

Steps to Confirm

  • [ ] list any manual steps taken to confirm the changes

Pre-Merge Checklist

  • [ ] All CI Pipelines Succeeded
  • Documentation Updated:
    • [ ] documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • [ ] documentation issue created (tag docs-team to complete issue separately)
  • [ ] Issue Requirements are Met
  • [ ] Relevant Follow-Up Issues Created
  • [ ] Update CHANGELOG.md

Description Of Changes

Write some things here about the changes and any potential caveats

sanders41 avatar Oct 12 '22 14:10 sanders41

@sanders41 I think we should clean up all of the README, since Dave found lots of issues in that issue

ThomasLaPiana avatar Oct 13 '22 03:10 ThomasLaPiana

Yes, I just saw he found some more. I will go through his findings and also look to see if I find any more.

sanders41 avatar Oct 13 '22 03:10 sanders41

@ThomasLaPiana I made updates to the README from the issues Dave found, and also a couple additional ones I found.

I was able to reproduce the fides push demo_resources/ error when starting fresh, but interestingly not always. I opened an issue here #1435. I think it's going to be a tough one to track down since I can't consistently get it to error.

For the warning messages I did a global search of the project and couldn't find those log messages so I'm not sure where they are coming from. I opened an issue for this one here #1434.

sanders41 avatar Oct 13 '22 14:10 sanders41

@sanders41 the warning messages for the env vars are actually coming from docker, and Neville fixed them in another PR (https://github.com/ethyca/fides/pull/1457)

I'll play around with this and try to figure out the push issue, since it should be checking the webserver's health before trying to run and that's the only intermittent thing I can think of here 🤔

ThomasLaPiana avatar Oct 17 '22 09:10 ThomasLaPiana

I just had a thought and I haven't had a chance to look into it yet so it may not make sense. Could it be possible that on the first run something gets written somewhere like fides.toml and it works after that? That would explain why it fails on the first run and works after that. It would also explain why it worked for me after clearing the volumes and trying again because clearing the volumes wouldn't clear what was written to the file.

sanders41 avatar Oct 17 '22 10:10 sanders41

I just had a thought and I haven't had a chance to look into it yet so it may not make sense. Could it be possible that on the first run something gets written somewhere like fides.toml and it works after that? That would explain why it fails on the first run and works after that. It would also explain why it worked for me after clearing the volumes and trying again because clearing the volumes wouldn't clear what was written to the file.

On the first run everything should be there though, it only triggers a separate flow if there's no fides.toml and even then, it would be an interactive prompt

ThomasLaPiana avatar Oct 18 '22 13:10 ThomasLaPiana

@sanders41 it ran just fine for me, which just means it didn't hit the intermittent error I guess

I'm cleaning up some other stuff and will push up another version shortly :)

ThomasLaPiana avatar Oct 18 '22 16:10 ThomasLaPiana

looks clean to me, waiting on design team to give us a new banner logo for the README

ThomasLaPiana avatar Oct 19 '22 11:10 ThomasLaPiana

uhhh I don't think these test failures are related but they are weird

ThomasLaPiana avatar Oct 21 '22 11:10 ThomasLaPiana

They are not related. This failure is happening everywhere now. I tried to track it down, but the test passes when I run it locally.

sanders41 avatar Oct 21 '22 11:10 sanders41