Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
11 of 15 tasks
krook opened this issue Jul 31, 2020 · 9 comments
Open
11 of 15 tasks

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

krook opened this issue Jul 31, 2020 · 9 comments
Labels
documentation Improvements or additions to documentation

Comments

@krook
Copy link
Member

krook commented Jul 31, 2020

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

@krook krook added the documentation Improvements or additions to documentation label Jul 31, 2020
@luisera
Copy link
Contributor

luisera commented Aug 8, 2020

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

@luisera
Copy link
Contributor

luisera commented Aug 8, 2020

"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
Copy link
Contributor

luisera commented Aug 8, 2020

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

@krook
Copy link
Member Author

krook commented Aug 9, 2020

"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
Copy link
Member

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

@krook
Copy link
Member Author

krook commented Aug 10, 2020

Related, particularly on the DCO bot: openeew/openeew#9

@djhunt-ibm
Copy link

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
Copy link
Member Author

krook commented Aug 14, 2020

@djhunt-ibm
Copy link

djhunt-ibm commented Aug 14, 2020

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants