Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update compatibility docs and release cutting notes #3796

Merged

Conversation

sunjayBhatia
Copy link
Member

@sunjayBhatia sunjayBhatia commented Jun 10, 2021

  • Adds release notes markdown template
  • Calls out in release process doc about what to include in release
    notes
  • Modifies notes in compatibility matrix to remove ambiguity
  • Minor updates in Philosophy document to bring it up to date
  • Makes README more general about k8s prerequisites

- Adds release notes markdown template
- Calls out in release process doc about what to include in release
notes
- Modifies notes in compatibility matrix to remove ambiguity
- Minor updates in Philosophy document to bring it up to date

Signed-off-by: Sunjay Bhatia <sunjayb@vmware.com>
@sunjayBhatia sunjayBhatia requested a review from a team as a code owner June 10, 2021 14:51
@sunjayBhatia sunjayBhatia requested review from skriss and youngnick and removed request for a team June 10, 2021 14:51
@codecov
Copy link

codecov bot commented Jun 10, 2021

Codecov Report

Merging #3796 (710e818) into main (caedf10) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3796   +/-   ##
=======================================
  Coverage   75.83%   75.83%           
=======================================
  Files         107      107           
  Lines        7338     7338           
=======================================
  Hits         5565     5565           
  Misses       1652     1652           
  Partials      121      121           

@sunjayBhatia sunjayBhatia requested a review from stevesloka June 10, 2021 15:06
Copy link
Member

@skriss skriss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks good, just a couple nits. I'd suggest also updating https://github.com/projectcontour/contour#prerequisites to have more general language along the lines of "refer to the compatibility matrix for supported versions" so we don't have to remember to update it.

site/content/resources/philosophy.md Outdated Show resolved Hide resolved
site/content/resources/release-process.md Outdated Show resolved Hide resolved
Signed-off-by: Sunjay Bhatia <sunjayb@vmware.com>
@sunjayBhatia sunjayBhatia requested a review from skriss June 10, 2021 15:14
Copy link
Member

@skriss skriss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stevesloka
Copy link
Member

Might need to also call out dropped support for Ingress v1beta1. I know it's removed from newer k8s versions, but could see users asking about this.

- Clean up compatibility matrix text
- Add a note to ingress doc about removal

Signed-off-by: Sunjay Bhatia <sunjayb@vmware.com>
@sunjayBhatia sunjayBhatia merged commit 12f8c2a into projectcontour:main Jun 15, 2021
@sunjayBhatia sunjayBhatia deleted the compatibility-doc-updates branch June 15, 2021 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants