This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-site.git
The following commit(s) were added to refs/heads/master by this push:
new 23e2ab741 Added references to issues and mailing lists on the main
page
23e2ab741 is described below
commit 23e2ab741b65d645a9b81b22f162acd8ab283ca3
Author: emmanuel lecharny <elecha...@apache.org>
AuthorDate: Fri Dec 6 06:47:36 2024 +0100
Added references to issues and mailing lists on the main page
---
layouts/_default/baseof.html | 6 +++++
source/_index.md | 14 +++++++-----
source/issue-tracking.md | 53 ++++++++++++++++++++++++++++++++++++++++++++
source/mailing-lists.md | 4 ++++
4 files changed, 72 insertions(+), 5 deletions(-)
diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html
index c696f064a..aa33c4c02 100644
--- a/layouts/_default/baseof.html
+++ b/layouts/_default/baseof.html
@@ -53,6 +53,12 @@
<li><a href="/sshd-project/index.html">SSHD</a></li>
<li><a href="/vysper-project/index.html">Vysper</a></li>
</ul>
+ <h5>Resources</h5>
+ <ul>
+ <li><a href="/mailing-lists.html" class="external-link"
rel="nofollow">Mailing lists & IRC</a></li>
+ <li><a href="/issue-tracking.html" class="external-link"
rel="nofollow">Issue tracking</a></li>
+ <li><a href="/sources.html" class="external-link"
rel="nofollow">Sources</a></li>
+ </ul>
<h5>Community</h5>
<ul>
diff --git a/source/_index.md b/source/_index.md
index a4439e1f6..fbc48c49e 100644
--- a/source/_index.md
+++ b/source/_index.md
@@ -10,9 +10,13 @@ Apache MINA is often called:
* client server framework library, or
* a networking socket library
-Apache MINA comes with many subprojects :
+Apache MINA comes with a core project and many subprojects :
-* AsyncWeb : An HTTP server build on top of MINA asynchronous framework
-* FtpServer : A FTP server
-* SSHd : A Java library supporting the SSH protocol
-* Vysper : An XMPP server
+* [Apache MINA](mina-project/) : The MINA framework, on which the sub-projects
are based
+
+and
+
+* [Apache AsyncWeb](asyncweb-project/) : An HTTP server build on top of MINA
asynchronous framework
+* [Apache FtpServer](ftp-project/) : A FTP server
+* [Apache SSHd](sshd-project/) : A Java library supporting the SSH protocol
+* [Apache Vysper](vysper-project/) : An XMPP server
diff --git a/source/issue-tracking.md b/source/issue-tracking.md
new file mode 100644
index 000000000..18c8076c3
--- /dev/null
+++ b/source/issue-tracking.md
@@ -0,0 +1,53 @@
+---
+type: mina
+title: Issue Tracking
+---
+
+Our project uses [JIRA](http://www.atlassian.com/software/jira), a Java EE
based issue tracking and project management application, and GitHub as an
alternative for some subprojects.
+
+Use either one, but please don't file the same issue at both.
+
+If neither option is suitable for you, issues can also be reported via
[e-mail](./mailing_lists.html) as a last resort.
+
+
+# General guidance
+
+First, this is the best place to submit bugs (or what you think is a bug). The
mailing list is a short term memory place, don't expect your problem to be
answered if it's not in the next couple of days you posted on it.
+
+What are the important information you need to put when filing a JIRA ?
+
+* The version you are using. This is mandatory. We are dealing with many
versions, and we don't have time to check what version you are using by looking
to your code.
+* The trace you got (attach them to the issue you have opened). Thread dumps,
logs, whatever you can provide is just better than nothing
+* Some code that expose the problem, if possible. Not thousands of lines, just
the bare minimum.
+* Some clear explanation on what's going on and what is expected instead, in
English of course. It does not have to be perfect english - most of the
committers aren't English native's speaker - but at least something we can
understand.
+* A short description in the title.
+* Last, not least, if you are kind enough to propose a patch, attach it and
__do not forget to check the box which grant The ASF the right to apply it in
the code base.__
+
+Remember that this issue tracking system is public. Would you provide some
confidential information, it will be visible to the world. Keep that in mind
before posting !!!
+
+
+# Filling an issue with JIRA
+
+Issues, bugs, and feature requests should be submitted to the following issue
tracking system, which differs with each sub-project :
+
+| | | |
+|---|---|---|
+| Project | JIRA key | Corresponding link to issue tracking system |
+| ASYNCWEB | ASYNCWEB |
[http://issues.apache.org/jira/browse/ASYNCWEB](http://issues.apache.org/jira/browse/ASYNCWEB)
|
+| FTP | FTPSERVER |
[http://issues.apache.org/jira/browse/FTPSERVER](http://issues.apache.org/jira/browse/FTPSERVER)
|
+| MINA | DIRMINA |
[http://issues.apache.org/jira/browse/DIRMINA](http://issues.apache.org/jira/browse/DIRMINA)
|
+| SSHd | SSHD |
[http://issues.apache.org/jira/browse/SSHD](https://issues.apache.org/jira/browse/SSHD)
|
+| VYSPER | VYSPER |
[http://issues.apache.org/jira/browse/VYSPER](http://issues.apache.org/jira/browse/VYSPER)
|
+
+# Filling an issue with GitHub issues
+
+| | |
+|---|---|
+| Project | Corresponding link to issue tracking system |
+|ASYNCWEB|[GitHub issues](https://github.com/apache/mina-asyncweb/issues)|
+|FTPSERVER|[GitHub issues](https://github.com/apache/mina-ftpserver/issues)|
+|SSHd|[GitHub issues](https://github.com/apache/mina-sshd/issues)|
+|VYSPER|[GitHub issues](https://github.com/apache/mina-vysper/issues)|
+
+
+
diff --git a/source/mailing-lists.md b/source/mailing-lists.md
index 43dc51be9..56fa3096b 100644
--- a/source/mailing-lists.md
+++ b/source/mailing-lists.md
@@ -18,6 +18,10 @@ More specifically, follow those simple rules :
* You may have find a bug in MINA, but it's way more likely that your code is
buggy.
* Don't be afraid to post, even if you think your english suck. Most of us are
not english native speakers, anyways ...
+Each subprojects use the same mailing list, so please remember to tag your
post with the sub-project name, like:
+
+"Question about XXX [mina-sshd]" for *SSHd* related mail or "Question about
YYY [mina]" for the *MINA* framework related mail.
+
Thanks for listening !
# Users mailing list
