ctubbsii commented on code in PR #461:
URL: https://github.com/apache/accumulo-website/pull/461#discussion_r2072078337


##########
_posts/release/4_0_api_changes.md:
##########


Review Comment:
   I'm not sure what will happen if we have an extra data file in the directory 
expecting release posts. Jekyll posts have specific directory layout 
conventions. I don't think this file should be here.
   
   Also, while I don't mind generating a good report and publishing it at some 
linked place, I don't think it should be embedded in the release notes. Our 
release notes are supposed to be a human-readable curated set of what we think 
are the important things to know about at a relatively high level. Generated 
technical docs that show diffs in a tabular format is out-of-place, and 
subtracts from the user's ability to quickly get the highlights of the release.
   
   Also, while the report is probably useful for us, to check our compatibility 
criteria for gating a release, I think it's probably not useful to a user for a 
major version bump. The major version bump itself already signals API 
incompatibilities, and the user's own code/build will be a much more reliable 
signal of what is incompatible than this generated report.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@accumulo.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to