Skip to content

Commit 23e0aee

Browse files
committed
Website fixes
- Fixed typos and grammar issues - Removed invalid mailing list warning from the team page - Removed out-of-place text
1 parent 8fc71fa commit 23e0aee

7 files changed

Lines changed: 101 additions & 51 deletions

File tree

content/community/_index.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Title: "Community"
1010

1111
## Support
1212

13-
If you are experiencing problems using Camel there are several channels available to seek help from the community.
13+
If you are experiencing problems using Camel, there are several channels available to seek help from the community.
1414
<p>
1515
<a class="button dark" href="/community/support/">Read More</a>
1616
</p>
@@ -29,6 +29,9 @@ If you are experiencing problems using Camel there are several channels availabl
2929

3030
One way to get help is to use the Camel mailing lists. This allows the entire community to help with your problem.
3131

32+
When posting to the mailing lists, please use plain text mails.
33+
Do not use HTML mails.
34+
3235
<p>
3336
<a class="button dark" href="/community/mailing-list/">Read More</a>
3437
</p>
@@ -46,7 +49,10 @@ One way to get help is to use the Camel mailing lists. This allows the entire co
4649

4750
## Contributing
4851

49-
There are many ways you can help make Camel better - please dive in and help!Identify areas you can contribute first. You don’t have to be an expert in an area, the Apache Camel developers are available to offer help and guidance.
52+
There are many ways you can help make Camel better.
53+
Please dive in and help!
54+
Identify areas you can contribute first.
55+
You don’t have to be an expert in an area, the Apache Camel developers are available to offer help and guidance.
5056

5157
<p>
5258
<a class="button dark" href="/community/contributing/">Read More</a>
@@ -64,7 +70,8 @@ There are many ways you can help make Camel better - please dive in and help!Ide
6470

6571
## User Stories
6672

67-
This page is intended as a place to collect user stories and feedback on Apache Camel. If you are using or have tried Apache Camel please add an entry or comment; or post to the mailing list.
73+
This page is intended as a place to collect user stories and feedback on Apache Camel.
74+
If you are using or have tried Apache Camel, please add an entry or comment; or post to the mailing list.
6875

6976
<p>
7077
<a class="button dark" href="/community/user-stories/">Read More</a>
@@ -100,7 +107,8 @@ Articles are divided into several sections. As the lists grow, further sectionin
100107

101108
## Books
102109

103-
This page lists the known books about Apache Camel. If you happen to know a book which is not listed then please contact us.
110+
This page lists the known books about Apache Camel.
111+
If you happen to know a book which is not listed, then please contact us.
104112

105113
<p>
106114
<a class="button dark" href="/community/books/">Read More</a>
@@ -118,7 +126,9 @@ This page lists the known books about Apache Camel. If you happen to know a book
118126

119127
## Team
120128

121-
This page lists who we are. By all means add yourself to the list - lets sort it in alphabetical order. When posting to the mailing lists, use plain text mails. Do not use HTML mails.
129+
This page lists who we are.
130+
By all means add yourself to the list.
131+
Let's sort it in alphabetical order.
122132

123133
<p>
124134
<a class="button dark" href="/community/team/">Read More</a>

content/community/books.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
title: "Books"
33
---
44

5-
This page lists the known books about Apache Camel. If you happen to know a book which is not listed then please contact us, for example using the [Mailing Lists](/community/mailing-list/).
5+
This page lists the known books about Apache Camel.
6+
If you happen to know a book which is not listed, then please contact us
7+
(i.e., using the [Mailing Lists](/community/mailing-list/)).
68

79
* [Cloud Native Integration with Apache Camel](https://www.apress.com/gp/book/9781484272107)
810
* [Camel in Action 2nd edition](http://manning.com/ibsen2/)

content/community/contributing.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22
title: Contributing
33
---
44

5-
Thank you for expressing your interest in contributing to Apache Camel, a versatile open-source integration framework. Apache Camel consists of various sub-projects, each with its own specific contribution guidelines. In order to ensure a smooth and effective contribution process, it is important to familiarize yourself with the guidelines specific to the sub-project you intend to contribute to. Check the pages for each of the sub-projects for details about how to contribute:
5+
Thank you for expressing your interest in contributing to Apache Camel, a versatile open-source integration framework.
6+
Apache Camel consists of various subprojects, each with its own specific contribution guidelines.
7+
To ensure a smooth and effective contribution process,
8+
it is important to familiarize yourself with the guidelines specific to the subproject you intend to contribute to.
9+
Check the pages for each of the subprojects for details about how to contribute:
610

711
* [Camel Core](/camel-core/contributing/)
812
* [Camel K](/camel-k/latest/)
@@ -11,10 +15,13 @@ Thank you for expressing your interest in contributing to Apache Camel, a versat
1115
* [Camel Quarkus](/camel-quarkus/latest)
1216
* [Camel Spring Boot](/camel-spring-boot/latest)
1317

14-
If in doubt about where to start, check the contributing guide from [Camel Core](/camel-core/contributing/index.html), which provides the overall guidelines for the project and contains comprehensive documentation that may apply for the sub-projects.
18+
If in doubt about where to start, check the contributing guide from [Camel Core](/camel-core/contributing/index.html), which provides the overall guidelines for the project and contains comprehensive documentation that may apply for the subprojects.
1519

16-
Please note that each sub-project may have its own specific development process, coding conventions, and contribution workflows. It is crucial to carefully review the respective guidelines to ensure your contributions align with each sub-project's standards and expectations.
20+
Please note that each subproject may have its own specific development process, coding conventions, and contribution workflows.
21+
It is crucial to carefully review the respective guidelines
22+
to ensure your contributions align with the subproject's standards and expectations.
1723

18-
We appreciate your interest in contributing to Apache Camel and encourage you to reach out if you have any further questions or need assistance. Your contributions will undoubtedly help enhance and strengthen the Apache Camel framework.
24+
We appreciate your interest in contributing to Apache Camel and encourage you to reach out if you have any further questions or need assistance.
25+
Your contributions will undoubtedly help enhance and strengthen the Apache Camel framework.
1926

20-
Thank you for your dedication and we look forward to your contributions.
27+
Thank you for your dedication, and we look forward to your contributions.

content/community/mailing-list.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,40 @@ title: "Mailing Lists"
44

55
## Read this first before posting
66

7-
### Which email list to use?
7+
### Mailing lists basics
8+
9+
To email the mailing list, you need to subscribe first by sending an email to the Subscribe email address listed below.
10+
11+
If you do not wish to receive any more emails, send a message to the Unsubscribe email address listed below.
812

9-
To send an email to the mailing list you need to subscribe first by sending an email to the Subscribe email address listed below. If you do not wish to receive any more emails send a message to the Unsubscribe email address listed below. If you do not subscribe to the mailing list your email will be sent to the moderation queue and most likely it will be rejected. You will not receive email responses sent directly to the mailing list on the topic you raised unless you are subscribed.
13+
If you do not subscribe to the mailing list, your email will be sent to the moderation queue and most likely it will be rejected.
14+
15+
You will not receive email responses sent directly to the mailing list on the topic you raised unless you are subscribed.
16+
17+
### Which email list to use?
1018

11-
If you want to discuss using Apache Camel please use the Users mailing list. Appropriate discussions for the Users' mailing list are questions or problems you encounter using Apache Camel, for example, “How do I…”. If in doubt use the Users' mailing list.
19+
If you want to **discuss using** Apache Camel, please use the Users' mailing list.
20+
Appropriate discussions for the Users'
21+
mailing list are questions or problems you encounter using Apache Camel, for example, “How do I…”.
22+
If in doubt, use the Users' mailing list.
1223

13-
If you wish to discuss contributing to Apache Camel please use the Developer mailing list. Do not discuss using Apache Camel on the Developers' mailing list.
24+
If you wish to **discuss contributing** to Apache Camel, please use the Developer mailing list.
25+
Do not discuss using Apache Camel on the Developers' mailing list.
1426

1527
The Commits and Issues mailing lists contain automated messages on changes to the source code or issue trackers, do not write to those mailing lists.
1628

17-
Again to re-iterate, use the User List, for your Camel questions. This is the correct mailing list and has the most people there ready for helping you.
29+
Again, to re-iterate, use the User's list for your Camel questions.
30+
This is the correct mailing list and has the most people there ready for helping you.
1831

19-
Sometimes it might be more appropriate to chat, and for that use the [Zulip chat](https://camel.zulipchat.com/). For other means of getting support see [Community support](/community/support/) and [Commercial Camel offerings](/manual/commercial-camel-offerings.html).
32+
Sometimes it might be more appropriate to chat, and for that use the [Zulip chat](https://camel.zulipchat.com/). For other means of getting support see [Community support](/community/support/) and [Commercial Camel offerings](/manual/commercial-camel-offerings.html).
2033

2134
### Post plain text mails
2235

23-
When posting to the mailing lists, use plain text mail. Do not use HTML mail. HTML mail is more likely to be targeted as spam mail and will be rejected; as well it’s not easily readable by others. Attachments, such as images, source code files, or project archives cannot be sent to the mailing lists, if you need to send an attachment upload it to a file/image-sharing website first and include the link to it in your message.
36+
When posting to the mailing lists, use plain text mail. Do not use HTML mail.
37+
HTML mail is more likely to be targeted as spam mail and will be rejected.
38+
As well, it’s not easily readable by others.
39+
Attachments, such as images, source code files, or project archives cannot be sent to the mailing lists.
40+
If you need to send an attachment, upload it to a file/image-sharing website first and include the link to it in your message.
2441

2542
### Mailing list addresses
2643

content/community/support.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ title: "Support"
44

55
## Getting help
66

7-
If you are experiencing problems using Camel then please report your problem to our mailing list or Zulip chat. This allows the entire community to help with your problem.
8-
If indeed a bug has been identified in the Camel software, then document the problem in our [Issue Tracker](https://issues.apache.org/jira/browse/CAMEL).
9-
Please refrain from immediately opening a ticket in the issue tracker unless you are certain it's a problem in the Camel software.
7+
If you are experiencing problems using Camel, then please report your problem to our mailing list or the Zulip chat.
8+
This allows the entire community to help with your problem.
9+
If indeed a bug has been identified in the Camel software,
10+
then document the problem in our [Issue Tracker](https://issues.apache.org/jira/browse/CAMEL).
11+
Please refrain
12+
from immediately opening a ticket in the issue tracker unless you are certain it's a problem in the Camel software.
1013

1114
If you are in doubt, we appreciate asking the [mailing list](/community/mailing-list/) or [Zulip](https://camel.zulipchat.com) chat first.
1215

@@ -18,36 +21,43 @@ Please read the section below (How to get help), and follow the bullets advised
1821
### Reporting bugs - Please read this first
1922

2023
We prefer people to get in touch first using the mailing list, or Zulip chat. Or take time to read FAQs, or search in the mailing list archives to find answers.
21-
Unfortunately some people create a JIRA ticket as first thing. **Please don't do that!** Only if you are sure it really is a bug etc. JIRA tickets create noise
24+
Unfortunately, some people create a JIRA ticket as first thing. **Please don't do that!** Only if you are sure it really is a bug etc. JIRA tickets create noise
2225
for the Camel team to react on issues that are not bugs but are already covered in FAQs, in the mailing lists etc., or in the existing documentation.
23-
Also on the mailing lists there are more people active to help you better.
26+
Also on the mailing lists, there are more people active to help you better.
2427

25-
Also please avoid sending direct emails to members of the Camel team - we are busy already. And conversations about Camel should happen in the public, and not via private emails.
28+
Also, please avoid sending direct emails to members of the Camel team (we are busy already).
29+
And conversations about Camel should happen in the public mailing lists, instead of via private emails.
2630

2731
### Reporting security issues
2832

29-
If you have found a security issue in Camel please contact the Apache Software Foundation [security team](https://www.apache.org/security/). Don't share the details in public (i.e. chat or users/developer mailing lists). We will receive details you send and resolve the issue as soon as possible. We might also contact you requesting further details as needed.
33+
If you have found a security issue in Camel,
34+
please contact the Apache Software Foundation [security team](https://www.apache.org/security/).
35+
Don't share the details in public (i.e., chat or users/developer mailing lists).
36+
We will receive details you send and resolve the issue as soon as possible.
37+
We might also contact you requesting further details as needed.
3038

3139
### Alternative discussion forums
3240

33-
There's a number of sites outside Apache that offer discussion forums on Camel. For example, [Stack Overflow](http://stackoverflow.com/) is a popular Q & A site with a dedicated [Apache Camel forum](http://stackoverflow.com/questions/tagged/apache-camel).
34-
You are also likely to find helpful discussions on technical blogs, on [Google](https://www.google.com/search?q=apache+camel), or even on [Twitter](https://twitter.com/#!/search/apache%20camel).
41+
There are a number of sites outside Apache that offer discussion forums on Camel.
42+
For example,[Stack Overflow](http://stackoverflow.com/) is a popular Q & A site with a dedicated [Apache Camel forum](http://stackoverflow.com/questions/tagged/apache-camel).
43+
You are also likely to find helpful discussions on technical blogs, on [Google](https://www.google.com/search?q=apache+camel),
44+
or even on [Twitter](https://twitter.com/#!/search/apache%20camel).
3545

3646
### Using deprecated components
3747

3848
Deprecated components are *not* supported and issues such as bugs may not be fixed. We encourage users to migrate away from using any deprecated component.
39-
A list of deprecated components is listed on the github page at: https://github.com/apache/camel/tree/master/components#components
49+
A list of deprecated components is listed on the GitHub page at: https://github.com/apache/camel/tree/master/components#components
4050

4151
### How to get help
4252

4353
Before you report a problem, you may wish to read the [FAQ](/manual/faq/index.html).
4454
When you report an issue, please be sure to include as much information as possible. The more we know, the easier it is to reach an effective solution quickly.
4555

46-
*What version do you use*
56+
The **most important information** you can provide us is the **version of Apache Camel** that you are using.
4757

48-
What version of Camel do you use? Remember to include this information.
58+
But not only that. Remember to also include information such as:
4959

50-
* what are the version numbers of involved software components? (this is very important to detail)
60+
* what are the version numbers of involved software components? (this is crucial)
5161
* what platform and JDK?
5262
* any particular container being used? and if so, what version?
5363
* stack traces generally really help! (Remember to post which version of Camel you use, this is important to know when posting stacktraces.) If in doubt, include the whole thing; often exceptions get wrapped in other exceptions and the exception right near the bottom explains the actual error, not the first few lines at the top. It's very easy for us to skim-read past unnecessary parts of a stack trace.
@@ -56,20 +66,20 @@ What version of Camel do you use? Remember to include this information.
5666
* did it work before? what have you changed to break it?
5767
* try upgrading to the latest release and see if it's fixed there
5868
* try the latest SNAPSHOT to see if it's fixed in the pre-release
59-
* search the user forum to see if has been discussed before
69+
* search the user forum to see if it has been discussed before
6070
* see the "known issues" section in the release notes
6171
* and check the issue tracker to see if the issue has already been reported
62-
* do *not* send private emails to Camel Team members to ask them to help you faster, or in the private only. Help on Apache Camel is volunteer based and must happen in the open on the public Mailing Lists. If you want to get help faster or in private, then see further below.
72+
* do *not* send private emails to Camel Team members to ask them to help you faster. Apache Camel support is volunteer-based and must happen in the open on the public Mailing Lists. If you want to get help faster or in private, then see further below.
6373

6474
### How to get help faster
6575

6676
We can help you much quicker if you try the following
6777

68-
* provide us with a JUnit test case that demonstrates your issue. e.g. if you think you've found a bug, can you create a test case to demonstrate the bug?
69-
* [submit a patch](/community/contributing/) fixing the bug! (We also buy you beer when we meet you if you submit bug fixes (smile) )
70-
* for memory leak or performance related issues, if you can run a profiler on your test case and attach the output as a file (or zipped file if it's huge) to the JIRA we can normally fix things much faster. For example, you could run jmap/jhat, JProfiler or YourKit on your code and send us the output. To find memory leaks it's quicker to resolve if you can tell us what classes are taking up all of the RAM; we can normally figure out what's wrong from that.
78+
* provide us with a JUnit test case that demonstrates your issue. For instance, if you think you've found a bug, can you create a test case to demonstrate the bug?
79+
* [submit a patch](/community/contributing/) fixing the bug. We may also buy you beer when we meet you if you submit bug fixes :)
80+
* for memory leak or performance related issues, attach the profiler or report output as a file (or zipped file if it's huge) to the JIRA we can normally fix things much faster. For example, you could run `jmap`/`jhat`, `perf`, the async profiler, JProfiler or YourKit on your code and send us the output. To find memory leaks, it's quicker to resolve if you can tell us what classes are taking up all the RAM; we can normally figure out what's wrong with that.
7181

7282
## Commercial Support
7383

7484
This is an open source project, so the amount of time we have available to help resolve your issue is often limited as all help is provided on a volunteer basis.
75-
If you want to get priority help, need to get up to speed quickly, require some training or mentoring, or need full 24 x 7 production support you could contact one of the following companies with [Commercial Camel Offerings](/manual/commercial-camel-offerings.html).
85+
If you want to get priority help, need to get up to speed quickly, require some training or mentoring, or need full 24 x 7 production support, you could contact one of the following companies with [Commercial Camel Offerings](/manual/commercial-camel-offerings.html).

0 commit comments

Comments
 (0)