contour-operator icon indicating copy to clipboard operation
contour-operator copied to clipboard

Add Operator to Contour Docs Site

Open danehans opened this issue 5 years ago • 8 comments

Please describe the problem you have projectcontour.io is the home to Contour's official documentation. These docs should be updated to include the operator.

  • [x] Operator installation, including any CRDs (if needed). Should the operator be an option in the Getting Started section?
  • [x] Deploy an instance of Contour. Should the operator be an option in the Deployment Options section? Note: The uninstall step should include deleting ns/contour-operator when using the operator.
  • [ ] Contour configuration reference. Similar to Contour's config reference.
  • [x] Update the supported versions matrix to include the operator.
  • [x] Upgrades- Add content to this or this. Note: Contour will not support upgrades for the v1alpha1 release.
  • [ ] Generate Contour API reference similar to Contour's API reference docs.
  • [x] Update the troubleshooting guide with steps on how to troubleshoot the operator.
  • [x] Does the release process doc need to be updated with operator-specific steps/section?
  • [x] Update the contributing guide with steps on how to contribute.

/cc @stevesloka @jpeach @Miciah

danehans avatar Oct 27 '20 16:10 danehans

Please include a blog post/segment in an a new release blog post :)

jonasrosland avatar Nov 10 '20 18:11 jonasrosland

https://github.com/projectcontour/contour/pull/3138 adds operator install to Contour's quickstart.

danehans avatar Nov 17 '20 22:11 danehans

https://github.com/projectcontour/contour/pull/3139 updates Contour's contrib page.

danehans avatar Nov 18 '20 19:11 danehans

Troubleshooting guide: https://github.com/projectcontour/contour/pull/3168

danehans avatar Dec 15 '20 00:12 danehans

Here is the operator-related content for Contour's v1.11.0 release. cc: @jonasrosland @stevesloka

danehans avatar Dec 17 '20 01:12 danehans

Release process doc update: https://github.com/projectcontour/contour/pull/3169

danehans avatar Dec 17 '20 01:12 danehans

This issue moved to the v1.12.0 milestone to resolve the remaining documentation requirements.

danehans avatar Jan 05 '21 17:01 danehans

I moved this to 1.14, as I don't think we'll finish up the outstanding in time. Definitely need to devote some resources to it though.

youngnick avatar Feb 22 '21 22:02 youngnick