cyralinc / approzium

Approzium allows a cloud service to authenticate to a database without ever having access to its password
https://approzium.com
Apache License 2.0
55 stars 7 forks source link

ENG-7519: Update Approzium with latest dependencies #235

Closed VictorGFM closed 2 years ago

VictorGFM commented 2 years ago

This PR updates the Approzium documentation by upgrading the docusaurus version and doing the necessary fixes required by the new dependencies.

Observation: The broken build is related to the node version used in the Netlify environment, which needs to be updated to >=14.

efreila commented 2 years ago

@VictorGFM Have you checked to make sure the docs compile and work locally? There are a ton of breaking changes between the current Docusaurus version and the one you're updating to in this PR and we should make sure it doesn't affect our docs in any way.

I'm not too familiar with this repo, but if we didn't do many customizations to the base Docusaurus platform, then we should most likely be good to go.

Edit: I looked through the source code and I'm seeing we're customizing three components: CodeBlock, Footer, and Navbar (found in src > theme. Did you check to make sure these are still working?

VictorGFM commented 2 years ago

Hey @efreila, thanks for taking a look into it. Yes, I took care of checking if the upgrade in the docusaurus had not impacted the build and the actual documentation.

All of the components are working and the docs are compiling just fine for every page. The UI is almost identical to the original one (including mobile), but it has a few differences if compared with the original one due to docussaurus component changes, for instance, the searchbar looks a little different now and the highlight of the CodeBlock uses a different color.

I didn't worry too much about those changes because I thought that this wouldnt impact that much in this particular case, but I can ensure that the docs look identical with the original one if you think thats better, just let me know.