search

jakartaee / transactions

Welcome to the Jakarta EE Transactions API Project (formerly JTA)
https://jakartaee.github.io/transactions/
Other
28 stars 29 forks source link

Set about of GitHub repo #206

Closed arjantijms closed 2 years ago

arjantijms commented 2 years ago

The about of this GitHub repo currently says:

"JTA API project"

To be consistent with most other project here, it should be

"Jakarta Transactions"

Can this be changed?

edbratt commented 2 years ago

yes, we need to file a web-dev ticket in gitlab. I've gone ahead and filed a ticket -- you're welcome to comment or just let it get picked up --- https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/1091

tomjenkinson commented 2 years ago

Thank you both - I gave the ticket a thumbs up.

@edbratt on the ticket, you referred to a gh-pages change - having had a quick look at (https://github.com/jakartaee/transactions/tree/gh-pages) I am unsure of whether it is that gh-pages you are referring to?

fredg02 commented 2 years ago

About section has been updated.

@tomjenkinson as project lead you should have the necessary permissions to change the about section yourself. Can you confirm that this is the case?

arjantijms commented 2 years ago

As project lead of various other projects I could change the about myself in those projects.

tomjenkinson commented 2 years ago

Thanks @fredg02 - and it turns out I have this access so if we need to change it again I could do it.

Thanks for the report @arjantijms and the assistance @edbratt

arjantijms commented 2 years ago

Thanks at @tomjenkinson. I see you set it to "Jakarta EE Transactions API Project". It's of course your choice, but I would recommend just saying "Jakarta Transactions" there ;)

fredg02 commented 2 years ago

Thanks at @tomjenkinson. I see you set it to "Jakarta EE Transactions API Project". It's of course your choice, but I would recommend just saying "Jakarta Transactions" there ;)

That was me, I set it as requested in the HelpDesk ticket.

edbratt commented 2 years ago

gh-pages branch contains the web-site. Today it just contains a readme file. We can point it anywhere we like or we can update the readme to include relevant information. I put in the bit about API project in the name since, I thought that was what it was (formerly Java Transactions API (JTA)(. Change it any way you like so that readers will know what this is about. Also, I wasn't aware that leads had this extra permission/role. I'll suggest that next time.

tomjenkinson commented 2 years ago

@edbratt regarding gh-pages comment, I think I might be understanding a bit more now that maybe a link to https://jakartaee.github.io/transactions/ should be on the about of https://github.com/jakartaee/transactions (and I see that is there, perhaps it was https://eclipse-ee4j.github.io/jta-api/ before?).

But on the other hand if you think there is some specific information needs to be updated in the readme itself (presumably https://github.com/jakartaee/transactions/blob/gh-pages/README.md?plain=1) then please let me know and I can make the change or you are welcome to raise a PR yourself and I can review it?

arjantijms commented 2 years ago

It might also be nice to have a little bit of consistency in the overview of projects.

E.g. look at this screenshot:

jakarta-projects

Notice how one is not like the others ;)

tomjenkinson commented 2 years ago

This section of the about which contains this text appears to be the "Description" field so, although it will not help with reaching consistency with those other repository that are only stating their name, perhaps we could consider to change the text to Welcome to the Jakarta Transactions API and specification repository. Jakarta Transactions enables distributed transactions to be done across multiple X/Open XA resources in a Java environment.?

That is both welcoming and descriptive as to the purpose of the repository (though it repeats some text from the README.md).

edbratt commented 2 years ago

Me personally, if the "about" text is just a repeat of the repository name, what is it adding? Hence, I used more words. I recognize the consistency you are pointing to but I think that's just because the Admins who set these up had no other guidance. Me personally, I like @tomjenkinson ' s latest suggestion.

Some projects use the gh-pages to provide project information and details. the project has complete autonomy over these contents. I have always felt that the projects should have the option of having their own web-space. If they want to use it -- for whatever reason (project tracking, hosting work-in-progress details, hosting legacy docs or non-normative material) -- they can and none of the other Jakarta process gets in the way.

We had made some attempts at trying to standardize templates and base content in Java EE days, but were never 100%. I believe there is a standard template we have been using -- I'm not certain which templates work in the new jakarta GitHub Organization. We might want something that looks different from the template that the implementations use.

If this project doesn't currently want to maintain any kind of project web-page presence, we can just merge a file that contains a redirect -- maybe to the EE4J (PMI) web page. Regretfully, that page is: https://projects.eclipse.org/projects/ee4j.jta -- not terribly informative but it could be made so (and maybe we can change the name from ee4j.jta to ee4j.transactions).

My main point is, now we have the link to a page location -- what this project wants to do with it is entirely up to this project.

arjantijms commented 2 years ago

Me personally, if the "about" text is just a repeat of the repository name, what is it adding?

True, though it does specify the full name. It may be a good idea to have a consistent format anyway, maybe the full name followed by the short description from here: https://jakarta.ee/specifications ?

So then it could be "Jakarta Transactions, allows handling transactions consistent with X/Open XA-spec"

tomjenkinson commented 2 years ago

I wonder if we might be able to reach agreement through the jakartaee-spec-project-leads whether the other projects would like to follow a similar pattern?

For me I think the following components would be nice:

  1. A welcoming statement
  2. The name of the project
  3. The scope of the repo (API, spec, TCK - as appropriate)
  4. The description of the project - as @arjantijms pointed out it could come from the description on https://jakarta.ee/specifications which works for me