search

ovn-org / ovn-kubernetes

A robust Kubernetes networking platform
https://ovn-kubernetes.io/
Apache License 2.0
767 stars 333 forks source link

Restructure docs folder and website for usability and clarity #4430

Open dtzhou2 opened 2 weeks ago

dtzhou2 commented 2 weeks ago

What this PR does and why is it needed

  1. Clean up old/unused files in docs/installation
  2. Add in files that werent referenced by mkdocs but considered relevant documentation
  3. Delete unused and irrelevant documentation (running_rpm.md)
  4. Move items in the website around for clarity (Introduction/introduction served the same purpose as getting started/introduction so I combined those sections and moved launching-ovn-kube-on-kind into the getting started folder since it seemed more relevant there)

Which issue(s) this PR fixes

Fixes #

Special notes for reviewers

Changed index.md to README.md. Tested with mkdocs and apparently using index.md instead of README.md means it will not properly be in a subheading in the website columns. Using README.md is workaround for that problem

How to verify it

Details to documentation updates

Instead of changing documentation mostly making sure documentation more accessible.

Description for the changelog

Refactored docs folder structure

Does this PR introduce a user-facing change?

coveralls commented 2 weeks ago

Coverage Status

coverage: 52.728% (+0.03%) from 52.702% when pulling 8c571d037543e4fc6df5afbee4a7abea3782ace8 on dtzhou2:doc_rearrangement into bf06da7893c1b1f2c516a666498f7976885ad248 on ovn-org:master.