openeew / openeew.com Goto Github PK

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.

• Add footnotes for sources in the docs: https://openeew.com/docs/introduction
• Add info on nearby networks: https://openeew.com/docs/contributing/
• Add test plan info back in if needed: https://openeew.com/docs/contributing/
• Review the copyright header block: https://openeew.com/docs/contributing/
• Add info about what the DCO is and how to configure https://openeew.com/docs/contributing/
• Sync up web site docs with latest GitHub component docs. Related to #4
• Fix the "access the credentials here" link on https://openeew.com/docs/deploy-detection-nodered
• Add metadata for the Python library https://pypi.org/project/openeew/

Populate these blank pages

• https://openeew.com/docs/create-dashboard
• https://openeew.com/docs/provision-sensor
• https://openeew.com/docs/update-firmware
• https://openeew.com/docs/create-dashboard
• https://openeew.com/docs/build-alarm
• https://openeew.com/docs/notify-3rd
• https://openeew.com/docs/intensity-prediction

This issue can track the feedback in #docs from Grzegorz Kieszkowski:

Hi,
I have just found out this project and I was on the website for the first time ever 15 mins ago so I will just leave my input as it may be fresh:

What I was looking on website:

• overview of project
• goal of project
• current state of project
• tech stack
• community information (ex. info on communication tools, town hall meetings, contact information)
• blog post
• demo
• roadmap

In short: I was looking for answer to questions "what" and "why"
What got me confused:

• detailed information on how to build a sensor, install, create dashboard etc.
• detailed instructions
• in general: sections "sensors","detection","monitor","alarms","data"

In short: "how-to" was a bit overwhelming and page navigation was problematic
I think that detailed instructions should be kept in github repo. keeping instructions on website:

1. documentation will be outdated very fast
2. it will be hard to maintain
3. it reaches user much slower
4. it may be overwhelming for newcomers

However I feel that there should be clear and easy information with provided github links for buildin, installing, deploying, using product.

I would start with listing audience of OpenEEW. Two basic groups:

1. Users: Seeking for information on product usage. Probably none to junior technical skills and knowledge. They require clear and detailed instructions which will not overwhelm them. In other words, product without well designed documentation will not be successful as they simply will not be able to use it.

2. Contributors: Seeking for information on community, contribution, meetings, OpenEEW management, tech stack. Junior to advanced technical skills and knowledge.
   Common matters for both groups: project overview, introduction, demo, contact information,

For example, the detection docker page should say near the top:

Additional instructions and the code can be found here.

Now that we have a red-based logo, should also sort out a matching web site palette to match.

It would be nice to see it Carbonized to match the dashboard in some way. Maybe not all in with React, but through a static site generator like it already uses.

For example:

• https://github.com/carbon-design-system/gatsby-theme-carbon
• https://gatsby-theme-carbon.now.sh/getting-started/

i will be updating the ui of the website without changing its theme like adding scrolling effect and little bit transition