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

Documentation is outdated #106

Open
5 tasks
XSpielinbox opened this issue Aug 18, 2023 · 1 comment · May be fixed by #105
Open
5 tasks

Documentation is outdated #106

XSpielinbox opened this issue Aug 18, 2023 · 1 comment · May be fixed by #105
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@XSpielinbox
Copy link

Describe the bug
When looking at the Angus Mail website and documentation there are still a lot of obsolete references (especially in the FAQ):

  • references to Java EE and JDK versions 7 and earlier that are all unsupported for quite a while now
  • dead links where there is no replacement, e.g. to the Oracle forum, no longer existent projects like SubEthaSMTP, socks.nec.com, Washington IMAP server, gotoh connect or Windows Live Hotmail help
  • references to old versions of Jakarta Mail, Tomcat, JavaBeans Activation Framework, Jakarta Activation and other things still in the javax namespace - shouldn't this all be migrated to Jakarta Activation for the API and Eclipse Angus for the reference implementation?
  • links to old third-party resources like blogs, that only talk about JavaMail where the applicability to Angus Mail and Jakarta EE is highly questionable to non-existent
  • references to SSL - are these SSL specific or could they be changed to TLS equivalents, as SSL should not be used anymore?

To Reproduce
e.g. visit https://eclipse-ee4j.github.io/angus-mail/FAQ.html

Expected behavior
There are no broken links in the documentation and one can clearly see what is still current and what is only there for historical reasons.

Additional context
The inconsistent use of Angus Mail and Jakarta Mail and the many broken links make the documentation and especially the FAQ more a source of confusion than answers. It also complicates finding the relevant information.

@jmehrens jmehrens added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 22, 2024
@jmehrens
Copy link
Contributor

PR is #105

@lukasj lukasj linked a pull request Jan 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants