openeew / openeew.com

Website for OpenEEW
https://openeew.com
8 stars 10 forks source link

chore(docs) Address documentation updates that need review #7

Open krook opened 4 years ago

krook commented 4 years ago

There are a few places in the docs that need a review and a decision on what change needs to be made. I've made obvious changes in this related pull request.

Populate these blank pages

luisera commented 4 years ago

"Add info on nearby networks: https://openeew.com/docs/contributing/" Not sure if this is required.

luisera commented 4 years ago

"Add test plan info back in if needed: https://openeew.com/docs/contributing/" This was added in the github docs of the scripts directly

luisera commented 4 years ago

"Add metadata for the Python library https://pypi.org/project/openeew/" Could you give an example? @krook

krook commented 4 years ago

"Add metadata for the Python library https://pypi.org/project/openeew/" Could you give an example? @krook

@luisera It looks like this was broken, then resolved, but now it shows "The author of this package has not provided a project description" on https://pypi.org/project/openeew/#description

andygrillo commented 4 years ago

@krook I lifted some language from the ClusterDuck Contributing file with regards to DCO.

krook commented 4 years ago

Related, particularly on the DCO bot: https://github.com/openeew/openeew/issues/9

djhunt-ibm commented 4 years ago

Any ideas on the open checklist item "Fix the 'access the credentials here' link on https://openeew.com/docs/deploy-detection-nodered"? I can't figure out how to run the first Node-RED example without a broker to connect to. Maybe I'm missing pointers to some other documentation on the brokers. Thanks!

krook commented 4 years ago

@djhunt-ibm this might have the missing piece. If it does, we should sync the repo with the tutorial: https://developer.ibm.com/events/call-for-code-live-build-node-red-dashboards-using-earthquake-sensor-data/ https://developer.ibm.com/tutorials/build-an-openeew-earthquake-early-warning-node-red-dashboard/

FYI @johnwalicki

djhunt-ibm commented 4 years ago

I did not see it either of those places, which led me here. The sample code for example one has a blank host name for the MQTT broker, and I wasn't sure if there's a public feed that we can attach to or if we have to simulate our own feed. Thanks!