moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

Feature Request: Add LightHouse Benchmarks for the website #108

Closed HarshCasper closed 3 years ago

HarshCasper commented 3 years ago

Is your feature request related to a problem? Please describe.

Currently, we are not tracking the performance of the documentation website. We can use automated benchmarking using LightHouse to achieve the same. It can allow us to generate clean HTML and JSON logs to keep track of the performance including other factors, like accessibility, best practices, SEO and more.

Describe the solution you'd like.

We can add a simple directory called benchmarks and a BASH script:

#!/bin/bash
if [ ${PWD##*/} != "benchmark" ]
then
        cd benchmark
fi
npx lighthouse https://docs.moja.global --output json --output HTML

Whenever it is run, we can generate the HTML and JSON which can be reviewed to understand the changes happening on the documentation website. The next step will be to add this over a GitHub Actions CI where we can run the workflow on a corn every fortnight and the HTML and JSON can be reviewed by uploading them as an artifact.

Describe alternatives you've considered

No response

Additional context.

No response

falguni-k commented 3 years ago

I would like to work on this. Please assign this to me

HarshCasper commented 3 years ago

Thanks for taking it up @falguni-k :rocket:

Please let me know if you need any help :hugs: