Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Currently we use the Hugo/Docsy/Netlify framework to generate and host the documentation. This section collects the pros and cons of the different frameworks. 

FrameworkProsCons
Hugo/Docsy/Netlify
  • We have a working framework
  • Other cloud native projects are using the same
  • Netlify is really easy to use
  • Versioning support is built in to the framework
  • Multi language support if built in to the framework
  • Using Netlify to publish means that we do not control the full pipeline of building and publishing the docs
  • Both Hugo and Docsy are sensitive to versions. There are lots of incompatibility issues.
  • There is a limit of traffic and biulds for the free open source tier of Netlify
MKdocs
  • Other projects, like Kubenet are using it

Hugo/Docsy/own server
  • We have a full control over the build and publication of our documentation
  • We do not depend on the goodwill of Netlify for the free service
  • It is not clear if we have a server to use
  • We need to build the whole pipeline to build and publish the documentation


Colors

These are the primary colors of the Nephio logo: 

...