sdnfv / openNetVM

A high performance container-based NFV platform from GW and UCR.
http://sdnfv.github.io/onvm/
Other
261 stars 134 forks source link

Updated ONVM ReadTheDocs Site #315

Closed jettjacobs closed 1 year ago

jettjacobs commented 2 years ago

Summary:

ONVM ReadTheDocs Site is complete. Link: opennetvm-readthedocs.readthedocs.io All of the most recent documentation within OVNM is now included on the website. Previous content within the "docs" directory has been removed.

Usage:

This PR includes
Resolves issues
Breaking API changes
Internal API changes
Usability improvements X
Bug fixes
New functionality
New NF/onvm_mgr args
Changes to starting NFs
Dependency updates
Web stats updates

Merging notes:

Current site is being hosted through @jettjacobs docs directory. Once approved, I will change the website source to reference the sdnfv/openNetVM repository on the develop or master branch

TODO before merging :

Test Plan:

All pages have been thoroughly checked to ensure proper hyperlinking and formatting. Nothing more needs to be done, although a brief read-through from somebody else could be beneficial!

Review:

None

twood02 commented 2 years ago

@jettjacobs - I think this was all ready to go, right? To finalize things we will need to merge this and then adjust the read-the-docs site so that it ports to the main repo instead of your fork, correct? When we do that, can we tell read-the-docs to use the develop branch instead of master?

jettjacobs commented 1 year ago

@twood02 sorry for the delay. That is correct, the new site is ready to go (right after I make the changes requested by @andreaseno), and I will redirect the read-the-docs source repository from my own fork to the ONVM develop branch after merging. In regards to those changes, I will have those done by the end of the weekend

twood02 commented 1 year ago

To resolve the merge conflicts I made a new PR from my branch. Replaced by #329