agrc / masquerade

Disguise UGRC's Web API endpoints as an Esri locator service.
https://github.com/agrc/masquerade#readme
MIT License
1 stars 0 forks source link

docs: add user-focused content to readme #44

Closed stdavis closed 2 years ago

stdavis commented 2 years ago

@steveoh Should this be a blog post? After I got going, I wondered if it should be in the website with a link to the GitHub repo similar to the API Client. I would prefer to keep it closer to the code in the readme, but I'm wondering if there's a reason why you did it that way with the API client.

codecov[bot] commented 2 years ago

Codecov Report

Merging #44 (e08b1bc) into main (580ed9f) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #44   +/-   ##
=======================================
  Coverage   85.06%   85.06%           
=======================================
  Files           3        3           
  Lines         308      308           
  Branches       35       35           
=======================================
  Hits          262      262           
  Misses         40       40           
  Partials        6        6           
Impacted Files Coverage Δ
src/masquerade/providers/open_sgid.py 94.02% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 580ed9f...e08b1bc. Read the comment docs.

stdavis commented 2 years ago

Is the issue that's causing the gcp monitor emails fixed?

It looked like to me the monitor emails are from errors querying open sgid. They didn't look prevelent enough to me to prevent a public release. I was going to ask you what you thought about me adding some retries.

stdavis commented 2 years ago

This is ready for a look. I'll copy the majority of this to a blog post on gis.utah.gov once it's merged.

stdavis commented 2 years ago

I prefer to use code blocks instead of quotes when giving instructions but that is only a stylistic choice. No need to change unless you think it's easier to read.

I'm using quotes so that the link works. But thanks for the idea.