We are using a very old version of mkdocs and mkdocs-material. Also, there are 4 open PR to update the dependencies.
Problem
As we are using a very old versions of mkdocs and mkdocs-material, which has certain security risks.
Evaluation
The security concerns are caused due to old version of mkdocs.
Solution
Update mkdocs 0.17.5 -> 1.4.2
Update mkdocs-material 2.9.2 -> 9.0.6
Update python from 3.7 -> 3.8
Update absolute links to relative links as mkdpcs version > 1.0.0 does not support absolute links.
Made some changes to UI look to incorporate some new features.
Important
Please refer https://github.com/delphix/docs-masking on the reason to delete the fullmaterial folder. As the overrides are no more required to remove certain header and customising the CSS.
Added delphix-brand.css which helps in keeping the color, logo size, admonition and tables as per the previous formats.
Background
We are using a very old version of mkdocs and mkdocs-material. Also, there are 4 open PR to update the dependencies.
Problem
As we are using a very old versions of mkdocs and mkdocs-material, which has certain security risks.
Evaluation
The security concerns are caused due to old version of mkdocs.
Solution
Important
materialfolder. As the overrides are no more required to remove certain header and customising the CSS.delphix-brand.csswhich helps in keeping the color, logo size, admonition and tables as per the previous formats.Testing done
Bonus