Update schema section of README

edgi-govdata-archiving / web-monitoring

Documentation and project-wide issues for the Website Monitoring project (a.k.a. "Scanner")

Creative Commons Attribution Share Alike 4.0 International

105 stars 17 forks source link

Update schema section of README #72

Closed patcon closed 6 years ago

patcon commented 7 years ago

Slack context: https://archivers.slack.com/archives/C47DJK8H0/p1506368749000003

@mr0grog said:

The README there is a little confusing and a lot out of date when you get to the schema stuff

Would the following be a good solution for moving that information somewhere less likely to decay?

To Do

[x] Flesh out swagger.yml API spec to include description on model properties, borrowing helpful text from the removed schema section of README.
[ ] ~Link to db/schema.rb in web-monitoring-db~
[x] Link to our Swagger UI for the model section. (For sample of how it's rendered, see the "status" prop on the Order model in the demo swagger api docs)
[x] Remove all content from Schema section
[x] enable deep-linking in ui ( See: https://github.com/swagger-api/swagger-ui/blob/master/docs/deep-linking.md)

Mr0grog commented 7 years ago

Flesh out swagger.yml API spec to include description…

Also all our existing swagger issues.

Link to db/schema.rb in web-monitoring-db

I am not particularly keen on this idea. That file is very Rails-specific and very much an implementation detail that does not necessarily reflect what you get out of the API.

I guess I should have been more clear in that the “a little confusing” was about the whole Readme, not just the schema section. I feel like I’ve had to fairly consistently re-explain it to a lot of people, so I don’t think it’s doing it’s job of giving an introduction and overview as well as it should.

That said, the above suggestions are good ones for doing away with the schema section and pointing to the resource we are doing a less bad job keeping accurate and up-to-date. That at least solves part of the problem.

Mr0grog commented 6 years ago

This is addressed in #105, I think. (Or hope?)

lightandluck commented 6 years ago

Yes, everything is addressed except for the task about enabling deep-linking (working link: https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/deep-linking.md)

Not sure use for this/why?

Mr0grog commented 6 years ago

Oh, I had totally missed that one (maybe because it says UI instead of DB). I’m guessing that was so parts of the schema section (now gone) could link directly to the correct part of the docs. Still a good idea to do anyway, so I just added edgi-govdata-archiving/web-monitoring-db#396.

Mr0grog commented 6 years ago

Closing this since all the sub-items are done.