Updated documentation or Wiki
julianjupiter opened this issue · comments
The website, https://javaee.github.io/hk2/, remains temporarily paused until now. I'm struggling looking for the updated documentation of HK2 (as well as Grizzly). The link of status provided returns 404: https://www.eclipse.org/ee4j/status.php.
At the moment I don't think there's anyone really working on this. Maybe @Cousjava would be interested? If you like to help out yourself too together with Jonathan I'm sure that would be much appreciated.
I don't think the documentation was donated
I don't think the documentation was donated
Does that mean a new documentation has to be created from scratch?
Is there any outline of things the new documentation should cover?
Can you go back to Oracle and ask for rights to the doc? I wrote most of it but it's owned by Oracle. I really don't think they would mind donating it if it would help get this kick started
@jwells131313 I can but would it be better for you to reach out to @edbratt or @m0mus or someone like that on the Oracle side?
Did someone find time to look into this? As @julianjupiter mentions, it's quite hard to find current documentation (or ask for clarification on the current one).
It needs someone on the Oracle side to see if docs can be donated to the Eclipse Foundation.
Hmm, are they even aware? From following the Apache NetBeans donation as a bystander I got the impression that sometimes some shoving is necessary ... 🤔
@julianjupiter indeed, can you contact Oracle? Maybe start with @m0mus or @edbratt ?
I'll raise on the PMC mailing list Grizzly and HK2 documentation
Generally, this was always planned, but (as with many issues like this) became overrun with other seemingly more urgent tasks and never reached the threshold of actual action. We can package up the material that was available in the javaee github organization at the time of contribution -- wash and tidy up the licenses and copyrights to meet Eclipse requirements -- and submit it for IP review (which should be rather perfunctory) -- then check it into the Eclipse GH repository.
Just to be clear - we'd be contributing the contents of java ee hk2 -- gh-pages branch. From here, someone would need to make any necessary updates to reflect any of the latest changes.
[I'm not sure it it makes sense to contribute the JavaDocs. Probably better to just use the current version(s) -- comments on this?]
Would that be sufficient (you can look at the legacy site to see what the contribution will consist of hk2-site (grizzly-site))?
[I can also update that "status" link since the page it used to point to seems to be gone :-( ]
I think the gh-pages is sufficient (assuming those docs sites are generated from the gh-pages)
I have committed, on the gh-pages branch Markdown content that was available from the legacy javaee/hk2 repository. I had intended to submit these changes through a PR, but I confused myself between my fork and the upstream repository and decided it wasn't worth trying to back it out. Sorry, but the content is now available for community use and evolution.
I will file a ticket for the Eclipse admins to enable the site. The link will be: eclipse-ee4j.github.io/glassfish-hk2.
Next thing will be to update the site content with the current JavaDocs and add content for the current release.
Docs are committed to the gh-pages branch and the new doc-site is operating as expected. I'm closing this issue. Further work to enhance/update these docs. can be handled in separate issue(s) and/or PRs. The first to things that come to mind (I've left in the branch readme.md) are add javadocs for the two Eclipse releases and update the docs themselves for v3.0. Hope this is useful.