eclipse-openj9 / openj9-docs

Source repository for the Eclipse OpenJ9 user documentation, which should be viewed [online]https://www.eclipse.org/openj9/docs/
Other
51 stars 73 forks source link

MkDocs version reverted to a previous version #1424

Open Sreekala-Gopakumar opened 1 week ago

Sreekala-Gopakumar commented 1 week ago

In the OpenJ9 user guide, there are some options that are clubbed together as a single topic but in the mkdocs.yml file we have given different option names pointing to the same topic. Earlier, the TOC used to show the options as we have listed in the .yml file, but after a build, it was showing the first option name for a topic as specified in the .yml file multiple times for some reason. Till 0.43.0 release, it was fine.

Screenshot 2024-07-23 at 6 48 56 PM

On investigating this matter, this was because of mkdocs version 1.6.1 (specified in the requirements.txt). This issue was reported in the following issues:

https://github.com/mkdocs/mkdocs/issues/3710 https://github.com/squidfunk/mkdocs-material/issues/7411

The issue is not yet fixed. The workaround is to revert to mkdocs version 1.5.3 and because of this version change, we had to revert the mkdocs-material version to 9.5.29 from 9.5.34 (because 1.5.3 is not compatible with 9.5.3 and later).

#1423 - Revert MkDocs version 1.6.1 to 1.5.3

Even though in the local machine mkdocs-material 9.5.29 worked, it showed compatibility issue on merging. On Peter's suggestion, changed the version to 9.5.18. According to https://squidfunk.github.io/mkdocs-material/changelog/ we could use at the latest 9.5.18, since 9.5.19 added the requirement for mkdocs 1.6

https://github.com/eclipse-openj9/openj9-docs/pull/1425

If this issue is fixed in mkdocs, we will have to update the versions. This issue will be closed only after that.

pshipton commented 1 week ago

The published docs for 0.47 are updated.