medic / cht-docs

Documentation site for the Community Health Tookit
https://docs.communityhealthtoolkit.org
14 stars 16 forks source link

Upgrade hugo and docsy #1437

Closed esthermmoturi closed 2 weeks ago

esthermmoturi commented 1 month ago
  1. Upgraded docsy to version 0.10.0 from 0.7.0
  2. Upgraded hugo to hugo v0.126.3+extended darwin/arm64
  3. Due to deprecated functions and a couple of style changes on the upgrades(refer to Docsy's changelog.md), I also:
    • Added a pageinfo.scss file to make the styling modular
    • Changed persistLang to persist since it became deprecated in 0.7.2
    • Changed --kind to _kind as it became depracated in 0.9.0

Some changes to note are:

  1. All links are now underlined
  2. Images have a boundary(box) to support dark mode
  3. Mermaid images are rendered with a different height
jkuester commented 1 month ago

@esthermmoturi unfortunately, I am going to be OOO until July 8th and will not be able to adequately review this before I leave. If it can wait, I will happily go through it when I get back, but otherwise you might need to get someone else to have a look.

esthermmoturi commented 1 month ago

Hey @jkuester , thank for letting me know.I'll add someone else as the reviewer.

garethbowen commented 1 month ago

I'm sorry to play hot potato but I'm not going to be able to get to this at least until next week. Because this is an upgrade to the framework and we don't have UI testing this will require significant manual testing effort (deploy locally and go through many pages on a range of devices). It's not really a code review but more of a manual test you need, right? Consider reaching out for a volunteer from the quality-assurance channel?

esthermmoturi commented 1 month ago

Yes @garethbowen, I did a majority of the manual tests but would like other eyes on the changes. I think @mrjones-plip has hugo and docsy already set up. @mrjones-plip , do you mind reviewing and testing these changes?

esthermmoturi commented 1 month ago

Hey @mrjones-plip , they changed a couple of things on the feedback and the mermaid which is causing the changes screenshot above. I am actively working to fix them. I suggest that I open another issue to fix those issues.

mrjones-plip commented 1 month ago

@esthermmoturi - I have a busy week, but will try and get to this by Friday. Stay tuned!

Feel free to pull someone else in to review the PR if you'd like.

esthermmoturi commented 1 month ago

Thanks @mrjones-plip , feel free to review when you get some time.

Issue 1 - Feedback form is missing

This has been fixed

esthermmoturi commented 1 month ago

@mrjones-plip , For Issue 2 - diagrams not rendered correct height on mobile. Docsy made changes in 0.9.0 such that mermaid resources are fetched on build time and they fetch the latest version of mermaid (hence the difference in height). We can choose to customize and specify the version of mermaid to be used in the config.toml file. I would advise against this except if there arises a greater issue. It would be good to benefit from any improvements made by mermaid. Mermaid is currently on version 10.9.0, if we specify the version we were on before (9.3.0), the images are rendered as they currently are on the docsite.

image image image
esthermmoturi commented 1 month ago

Commit https://github.com/medic/cht-docs/pull/1437/commits/a8c2f5706bbd34fed276a6069436ab29d4eaed78 fixes WARN deprecated issues

image
esthermmoturi commented 2 weeks ago

Thanks @mrjones-plip for looking into this and for bringing up the issue with Mermaid charts, I have opened an issue on the same for me to do a follow up.