[GitHub] [tomee-site-generator] cesarhernandezgt commented on pull request #37: TOMEE-3846 improve main comparison page and fix per version comparison pages
cesarhernandezgt commented on PR #37: URL: https://github.com/apache/tomee-site-generator/pull/37#issuecomment-1103416956 Thank you for the updates @sultan. So far, I haven't been able to pull your changes, but I hope to have time by the end of the week and provide feedback if needed by then. -- 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: dev-unsubscr...@tomee.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: TOMEE-3846 flavors comparison page / TOMEE-3871 - TomEE Plume is missing BatchEE / JCS Cache
Those pages looking great! Left some specific comments in the PR. > On Apr 17, 2022, at 12:10 PM, Swell wrote: > > Thank you all for your feedbacks, comparison pages sent for review: > + https://github.com/apache/tomee/pull/854 > + https://github.com/apache/tomee/pull/855 Thanks for tracking down all that version information! That's always a lot of tedious digging. > you might want those two "per-version" comparison pages to be without the > tables for "flavors" and "implementations" since these tables also are in > the "main" comparison page in the website PR: I agree we definitely don't want it in two places. In my experience documentation doesn't get maintained well, so anything duplicated usually ends up drifting apart and causing confusion. My vote would be to kill the implementation information from the main comparison and leave that information only in the comparison pages dedicated to their specific version. -David > > On Tue, 12 Apr 2022 at 21:04, David Blevins wrote: > >> Sounds awesome, everyone. >> >> Total side note. I cannot express how much I love seeing this much >> engagement and collaboration. Often times PRs don't get any feedback at >> all and sit for months. It's really fantastic to see activity like this. >> >> >> -David >> >> >>> On Apr 12, 2022, at 11:29 AM, Swell wrote: >>> >>> This reflects my first attempts, i still have them "per-version" >>> uncommited, already linking to specs by precise version >>> >>> so it wont be too hard for me to turn around, and give you these >> versions. >>> >>> the drawback is these pages may have to be maintained on dependencies >>> updates and releases, but that may be ok and clearer for users visiting >> the >>> website. >>> >>> i'll send the per version to "tomee" repo first then the page for website >>> repo >>> >>> On Tue, 12 Apr 2022 at 20:09, Zowalla, Richard < >>> richard.zowa...@hs-heilbronn.de> wrote: >>> Makes sense, imho. Thanks for the thoughts, David. That would simplify it for the reader. If we have it per version and link the per version documents from the overall comparision, we are proabably in a good shape. Am Dienstag, dem 12.04.2022 um 10:58 -0700 schrieb David Blevins: > Hey All, > > I see there's a big thread on PR#37. > > - https://github.com/apache/tomee-site-generator/pull/37 > > My gut reaction is that we might be trying to achieve the impossible > by trying to fit every TomEE version and every Java EE/Jakarta EE > version into one massive matrix or page. > > What do people think about potentially pausing that, taking a step > back and seeing if there's a simpler approach. Often when I'm > working on code and I notice it's getting just too big and hard to > fit in my head or on the page in a way that makes sense, I change my > approach. Instead of trying to solve the whole problem at once, I > just take a slice of it that I know I'll need and work on it till > it's clean. Then I move on and take another small slice and > repeat. As I keep going I often find there is no more big mess, not > because I found a better way to do it, but because I never needed it. > > My advice would be to give this a try. Pause the big PR#37 and shift > gears. Instead try nailing just a basic comparison page for TomEE 9 > that is like the one that's there, but adds the spec versions, links > to the spec documents and the java information. > > I.e. we copy this page > > - > >> https://github.com/apache/tomee-site-generator/blob/master/src/main/jbake/content/comparison.adoc > > To here: > > - > https://github.com/apache/tomee/commits/master/docs/comparison.adoc > > Then we start with adding the spec versions and the spec links and > get that merged. Afterwards we try adding the java information, and > get that merged. Once we have a page we all like, we move on and do > the same for TomEE 8.0 > > - > https://github.com/apache/tomee/blob/tomee-8.x/docs/comparison.adoc > > If we have the energy, let's do 7.1 and 7.0 since we're still > releasing those once in a while. > > Each page will be of course only mentioning the specifications they > implement. We can even use the exact spec names as they existed, so > for example, all the TomEE 7.0 stuff would say "Java EE" not "Jakarta > EE" and use "Enterprise JavaBeans" not "Jakarta EnterpriseBeans", > etc. > > Once we get individual pages for each TomEE version, we will likely > have a different perspective on what we need for the main comparison > page. Possibly we'll need very little as the individual pages will > be doing most the hard work. > > > Thoughts? > > > -David > >> On Apr 5, 2022, at 5:42 AM, Swell wrote: >>
[GitHub] [tomee-site-generator] sultan commented on pull request #37: TOMEE-3846 improve main comparison page and fix per version comparison pages
sultan commented on PR #37: URL: https://github.com/apache/tomee-site-generator/pull/37#issuecomment-1103143655 > Thank you @sultan for the PR updates and @rzo1 for the review. So awesome to see that the Windows issue was fixed! > > > do we both need Jakarta EE 9.0 and 9.1 javadoc on site ? we totally can but maybe 9.1 only is enough? what do you think ? > > I would vote +1 for only 9.1. But my opinion is that this work/proposal can be part of a new ticket to limit the scope of the current ticket to only comparison page content. > @cesarhernandezgt i made a separated ticket for the javadoc https://github.com/apache/tomee-site-generator/pull/40 -- 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: dev-unsubscr...@tomee.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [tomee-site-generator] sultan commented on pull request #40: TOMEE-3917 update javadoc to reflect update to MicroProfile 5.0
sultan commented on PR #40: URL: https://github.com/apache/tomee-site-generator/pull/40#issuecomment-1103046791 Jakarta EE 9 javadoc was taken from master, which is wrong since master is for Jakarta EE Next (10) @dblevins i will do it manually, unless you have a tag similar to EE4J_8 for V9.1 for every sub-spec (e.g. https://github.com/eclipse-ee4j/common-annotations-api/tree/EE4J_8 , etc ) -- 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: dev-unsubscr...@tomee.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [tomee-site-generator] sultan opened a new pull request, #40: TOMEE-3917 update javadoc to reflect update to MicroProfile 5.0
sultan opened a new pull request, #40: URL: https://github.com/apache/tomee-site-generator/pull/40 updating javadoc at website https://tomee.apache.org/docs.html replace jakartaee-9.0 by jakartaee-9.1 and add microprofile-5.0 and 4.1 -- 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: dev-unsubscr...@tomee.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [tomee-site-generator] sultan commented on pull request #37: TOMEE-3846 improve main comparison page and fix per version comparison pages
sultan commented on PR #37: URL: https://github.com/apache/tomee-site-generator/pull/37#issuecomment-1102903928 commits squashed -- 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: dev-unsubscr...@tomee.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [tomee] sultan commented on pull request #854: TOMEE-3846 improve documentation
sultan commented on PR #854: URL: https://github.com/apache/tomee/pull/854#issuecomment-1102874226 commits squashed -- 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: dev-unsubscr...@tomee.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [tomee] sultan commented on pull request #855: TOMEE-3846 improve documentation
sultan commented on PR #855: URL: https://github.com/apache/tomee/pull/855#issuecomment-1102874133 commits squashed -- 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: dev-unsubscr...@tomee.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
