Skip to content

Conversation

SumoSourabh
Copy link
Contributor

@SumoSourabh SumoSourabh commented Jan 24, 2023

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

  1. Update mkdocs 0.17.5 -> 1.4.2
  2. Update mkdocs-material 2.9.2 -> 9.0.6
  3. Update python from 3.7 -> 3.8
  4. Update absolute links to relative links as mkdpcs version > 1.0.0 does not support absolute links.
  5. Made some changes to UI look to incorporate some new features.

Important

  1. 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.
  2. Added delphix-brand.css which helps in keeping the color, logo size, admonition and tables as per the previous formats.
  3. PR that will be closed
  4. Also, merging the PR will remove 6 security concerns https://github.com/delphix/virtualization-sdk/security/dependabot for the repo.

Testing done

Bonus

  • Updated the python version to 3.8
  • Removed all unused / redundant files (full material folder)
  • Added support for linkcheck.

Copy link
Contributor

@ravi-cm ravi-cm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And all the files removed are no longer required?

Ship-it once comments are resolved.

@SumoSourabh SumoSourabh merged commit 94ac68c into delphix:develop Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants