search

cyberman54 / ESP32-Paxcounter

Wifi & BLE driven passenger flow metering with cheap ESP32 boards
https://cyberman54.github.io/ESP32-Paxcounter/
Other
1.69k stars 397 forks source link

Documentation for the project with Mkdocs Material #919

Closed t-huyeng closed 1 year ago

t-huyeng commented 1 year ago

Converting the current Readme.md into web page documentation using mkdocs material.

Looking forward to any feedback!

See: https://t-huyeng.github.io/ESP32-Paxcounter/ for the running webpage at my fork.

FYI: local testing/developing of mkdocs material is pretty easy if you have docker installed and running. Just use 

 docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

in the root directory of this project.

If this gets merged GitHub Pages needs to enabled for this project and set to the github-pages branch.

cyberman54 commented 1 year ago

If this gets merged GitHub Pages needs to enabled for this project and set to the github-pages branch.

Done.

t-huyeng commented 1 year ago

I created the favicon.png, so now copyrights from my side.

That looks all good, thank for creation!

One question regarding new file favicon.png: Licence? Or is this free of copyrights?

t-huyeng commented 1 year ago

Thanks for the merge.

Sadly, the pages build and deployment action is not triggered. (https://github.com/cyberman54/ESP32-Paxcounter/actions/workflows/pages/pages-build-deployment)

This should normally work out of the box automatically.

cyberman54 commented 1 year ago

What can we do now?

t-huyeng commented 1 year ago

I just updated my fork (master) and here the pages deployment gets triggered automatically. As far as I can see GitHub Pages should be configured correctly but can you confirm the same setup I have:

image

cyberman54 commented 1 year ago

Annotations

1 warning

deployInput 'emit_telemetry' has been deprecated with message: Use of this input causes the action to do nothing. You should remove this build step from your workflow.

Annotations 1 warning deploy Input 'emit_telemetry' has been deprecated with message: Use of this input causes the action to do nothing. You should remove this build step from your workflow.

t-huyeng commented 1 year ago

Annotations

1 warning

deployInput 'emit_telemetry' has been deprecated with message: Use of this input causes the action to do nothing. You should remove this build step from your workflow.

Annotations 1 warning deploy Input 'emit_telemetry' has been deprecated with message: Use of this input causes the action to do nothing. You should remove this build step from your workflow.

This should not be a problem. I have the same warning, and also this workflow is from GitHub itself.

t-huyeng commented 1 year ago

What can we do now?

Maybe you could force rebuild with a simple change of something in the docs and commit directly to the master branch.

Or maybe it has something todo with the github-pages branch existing before.

I try to find out more.

cyberman54 commented 1 year ago

settings looks identical. I kicked off a re-run manually. Still no deployment.

t-huyeng commented 1 year ago

Okay.

The branch looks good: https://github.com/cyberman54/ESP32-Paxcounter/tree/gh-pages So mkdocs deployment was successful. ~Something is not working with the github pages build/deployment.~

cyberman54 commented 1 year ago

Here's the extended log of run: https://github.com/cyberman54/ESP32-Paxcounter/actions/runs/3526728428/jobs/5921923721

t-huyeng commented 1 year ago

Its working! Just our browser cache fooling with us.

Try reload with shift f5.

Still not 100 % sure why a manual retrigger was needed so we need to keep an eye on this for the next changes.

t-huyeng commented 1 year ago

If you want you can add the docs link to the about section like I have on my fork: image