This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-website.git
commit 23e0aeec09a9b3ab0302341beaaa21bed15f0f68
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Thu Sep 12 10:37:45 2024 +0200
Website fixes
- Fixed typos and grammar issues
- Removed invalid mailing list warning from the team page
- Removed out-of-place text
---
content/community/_index.md | 20 ++++++++++++----
content/community/books.md | 4 +++-
content/community/contributing.md | 17 ++++++++++----
content/community/mailing-list.md | 31 +++++++++++++++++++------
content/community/support.md | 48 +++++++++++++++++++++++----------------
content/community/team.md | 9 +++-----
content/docs/_index.md | 23 ++++++++++++-------
7 files changed, 101 insertions(+), 51 deletions(-)
diff --git a/content/community/_index.md b/content/community/_index.md
index c9246371..04f50385 100644
--- a/content/community/_index.md
+++ b/content/community/_index.md
@@ -10,7 +10,7 @@ Title: "Community"
## Support
-If you are experiencing problems using Camel there are several channels
available to seek help from the community.
+If you are experiencing problems using Camel, there are several channels
available to seek help from the community.
<p>
<a class="button dark" href="/community/support/">Read More</a>
</p>
@@ -29,6 +29,9 @@ If you are experiencing problems using Camel there are
several channels availabl
One way to get help is to use the Camel mailing lists. This allows the entire
community to help with your problem.
+When posting to the mailing lists, please use plain text mails.
+Do not use HTML mails.
+
<p>
<a class="button dark" href="/community/mailing-list/">Read More</a>
</p>
@@ -46,7 +49,10 @@ One way to get help is to use the Camel mailing lists. This
allows the entire co
## Contributing
-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.
+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.
<p>
<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
## User Stories
-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.
+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.
<p>
<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
## Books
-This page lists the known books about Apache Camel. If you happen to know a
book which is not listed then please contact us.
+This page lists the known books about Apache Camel.
+If you happen to know a book which is not listed, then please contact us.
<p>
<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
## Team
-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.
+This page lists who we are.
+By all means add yourself to the list.
+Let's sort it in alphabetical order.
<p>
<a class="button dark" href="/community/team/">Read More</a>
diff --git a/content/community/books.md b/content/community/books.md
index 87623f32..e299914d 100644
--- a/content/community/books.md
+++ b/content/community/books.md
@@ -2,7 +2,9 @@
title: "Books"
---
-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/).
+This page lists the known books about Apache Camel.
+If you happen to know a book which is not listed, then please contact us
+(i.e., using the [Mailing Lists](/community/mailing-list/)).
* [Cloud Native Integration with Apache
Camel](https://www.apress.com/gp/book/9781484272107)
* [Camel in Action 2nd edition](http://manning.com/ibsen2/)
diff --git a/content/community/contributing.md
b/content/community/contributing.md
index ce488de7..3dd1a566 100644
--- a/content/community/contributing.md
+++ b/content/community/contributing.md
@@ -2,7 +2,11 @@
title: Contributing
---
-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:
+Thank you for expressing your interest in contributing to Apache Camel, a
versatile open-source integration framework.
+Apache Camel consists of various subprojects, each with its own specific
contribution guidelines.
+To ensure a smooth and effective contribution process,
+it is important to familiarize yourself with the guidelines specific to the
subproject you intend to contribute to.
+Check the pages for each of the subprojects for details about how to
contribute:
* [Camel Core](/camel-core/contributing/)
* [Camel K](/camel-k/latest/)
@@ -11,10 +15,13 @@ Thank you for expressing your interest in contributing to
Apache Camel, a versat
* [Camel Quarkus](/camel-quarkus/latest)
* [Camel Spring Boot](/camel-spring-boot/latest)
-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.
+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.
-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.
+Please note that each subproject 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 the subproject's standards and
expectations.
-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.
+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.
-Thank you for your dedication and we look forward to your contributions.
\ No newline at end of file
+Thank you for your dedication, and we look forward to your contributions.
\ No newline at end of file
diff --git a/content/community/mailing-list.md
b/content/community/mailing-list.md
index f9fbd728..5c5731fa 100644
--- a/content/community/mailing-list.md
+++ b/content/community/mailing-list.md
@@ -4,23 +4,40 @@ title: "Mailing Lists"
## Read this first before posting
-### Which email list to use?
+### Mailing lists basics
+
+To email 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.
-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.
+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.
+
+### Which email list to use?
-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.
+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.
-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.
+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.
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.
-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.
+Again, to re-iterate, use the User's list for your Camel questions.
+This is the correct mailing list and has the most people there ready for
helping you.
-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).
+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).
### Post plain text mails
-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.
+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.
### Mailing list addresses
diff --git a/content/community/support.md b/content/community/support.md
index 95c44669..74b4e81b 100644
--- a/content/community/support.md
+++ b/content/community/support.md
@@ -4,9 +4,12 @@ title: "Support"
## Getting help
-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.
-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).
-Please refrain from immediately opening a ticket in the issue tracker unless
you are certain it's a problem in the Camel software.
+If you are experiencing problems using Camel, then please report your problem
to our mailing list or the Zulip chat.
+This allows the entire community to help with your problem.
+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).
+Please refrain
+from immediately opening a ticket in the issue tracker unless you are certain
it's a problem in the Camel software.
If you are in doubt, we appreciate asking the [mailing
list](/community/mailing-list/) or [Zulip](https://camel.zulipchat.com) chat
first.
@@ -18,36 +21,43 @@ Please read the section below (How to get help), and follow
the bullets advised
### Reporting bugs - Please read this first
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.
-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
+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
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.
-Also on the mailing lists there are more people active to help you better.
+Also on the mailing lists, there are more people active to help you better.
-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.
+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 mailing lists,
instead of via private emails.
### Reporting security issues
-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.
+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.
### Alternative discussion forums
-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).
-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).
+There are 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).
+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).
### Using deprecated components
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.
-A list of deprecated components is listed on the github page at:
https://github.com/apache/camel/tree/master/components#components
+A list of deprecated components is listed on the GitHub page at:
https://github.com/apache/camel/tree/master/components#components
### How to get help
Before you report a problem, you may wish to read the
[FAQ](/manual/faq/index.html).
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.
-*What version do you use*
+The **most important information** you can provide us is the **version of
Apache Camel** that you are using.
-What version of Camel do you use? Remember to include this information.
+But not only that. Remember to also include information such as:
-* what are the version numbers of involved software components? (this is very
important to detail)
+* what are the version numbers of involved software components? (this is
crucial)
* what platform and JDK?
* any particular container being used? and if so, what version?
* 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.
* did it work before? what have you changed to break it?
* try upgrading to the latest release and see if it's fixed there
* try the latest SNAPSHOT to see if it's fixed in the pre-release
-* search the user forum to see if has been discussed before
+* search the user forum to see if it has been discussed before
* see the "known issues" section in the release notes
* and check the issue tracker to see if the issue has already been reported
-* 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.
+* 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.
### How to get help faster
We can help you much quicker if you try the following
-* 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?
-* [submit a patch](/community/contributing/) fixing the bug! (We also buy you
beer when we meet you if you submit bug fixes (smile) )
-* 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.
+* 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?
+* [submit a patch](/community/contributing/) fixing the bug. We may also buy
you beer when we meet you if you submit bug fixes :)
+* 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.
## Commercial Support
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.
-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).
+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).
diff --git a/content/community/team.md b/content/community/team.md
index 3b1b9c35..ceb698ad 100644
--- a/content/community/team.md
+++ b/content/community/team.md
@@ -2,12 +2,10 @@
title: "Team"
---
-This page lists who we are. By all means add yourself to the list - lets sort
it in alphabetical order
+This page lists who we are. By all means add yourself to the list. Let's sort
it in alphabetical order
## Committers
-When posting to the mailing lists, use plain text mails. Do not use HTML
mails. HTML mails is more likely to be targeted as spam mails and will be
rejected; as well it's not easily readable by others.
-
{{< table >}}
| Name | ID | Organisation |
|------------------------|------------------|----------------------------|
@@ -84,9 +82,8 @@ When posting to the mailing lists, use plain text mails. Do
not use HTML mails.
### Contributors
-Adding your name to the list below.
-
-If you have been contributing to the Apache Camel project, and you want your
name added to the list below. Then you can get in touch with the Camel team
from the [Mailing Lists](../mailing-list/) and ask to be added.
+If you have been contributing to the Apache Camel project, and you want your
name added to the list below.
+Then you can get in touch with the Camel team from the [Mailing
Lists](../mailing-list/) and ask to be added.
{{< table >}}
| Name | Organisation |
diff --git a/content/docs/_index.md b/content/docs/_index.md
index c7315471..96cc1d55 100644
--- a/content/docs/_index.md
+++ b/content/docs/_index.md
@@ -10,9 +10,10 @@ Title: "Documentation"
## Camel Core
-The foundation for all other projects. Ideal for experienced Java developers
or achitects willing to innovate and build upon a lower level integration
framework.
+The foundation for all other projects. Ideal for experienced Java developers
or architects willing to innovate and build upon a lower level integration
framework.
-The [User Manual](/manual/) is a comprehensive guide meant to help you with
the key concepts of Apache Camel and software integration, from how to [get
started](/manual/getting-started.html) with Apache Camel, how to [upgrade to
Camel 3.x](/manual/camel-3x-upgrade-guide.html), to
[architecture](/manual/architecture.html) or [integration
patterns](/components/latest/eips/enterprise-integration-patterns.html).
+The [User Manual](/manual/) is a comprehensive guide meant to help you with
the key concepts of Apache Camel and software integration.
+For instance, you can find information such as how to [get
started](/manual/getting-started.html) with Apache Camel, how to [upgrade to
Camel 4.x](/manual/camel-4x-upgrade-guide.html), information about Apache Camel
[architecture](/manual/architecture.html), [integration
patterns](/components/latest/eips/enterprise-integration-patterns.html) and
more.
<p>
<a class="button dark" href="/camel-core/">Documentation</a>
@@ -22,7 +23,8 @@ The [User Manual](/manual/) is a comprehensive guide meant to
help you with the
</p>
-Camel is packed with several hundred components that are used to access
databases, message queues and APIs. The [Component
reference](/components/latest/) provides you information about the
functionality and configuration of each component.
+Camel is comes with several hundred components that can be used to access
databases, message queues, and APIs.
+The [Component reference](/components/latest/) provides you information about
the functionality and configuration of each component.
<p>
<a class="button dark" href="/components/latest/">Component Reference</a>
@@ -39,7 +41,10 @@ Camel is packed with several hundred components that are
used to access database
## Camel K
-Apache Camel K is a lightweight integration framework built on Apache Camel
that runs natively on [Kubernetes](https://kubernetes.io/) and is specifically
designed for serverless and micro service architectures. It allows you to run
integration code written in Camel DSL on your cloud.
+Apache Camel K is a lightweight integration framework built on Apache Camel
+that runs natively on [Kubernetes](https://kubernetes.io/)
+and is specifically designed for serverless and microservice architectures.
+It allows you to run integration code written in Camel DSL on your cloud.
<p>
<a class="button dark" href="/camel-k/latest/">Documentation</a>
@@ -79,7 +84,7 @@ Camel Kafka Connector allows you to use all [Camel
components](/components/lates
## Camel Quarkus
-This project hosts the efforts to port and package most of the Camel
components as Quarkus extensions. [Quarkus](https://quarkus.io/) is a Java
platform offering fast boot times and low memory footprint. It targets both
stock JVMs and GraalVM.
+This project hosts the efforts to port and package most of the Camel
components as Quarkus extensions. [Quarkus](https://quarkus.io/) is a Java
platform offering fast boot times and low memory footprint. It targets both
stock JVMs and the GraalVM.
<p>
<a class="button dark" href="/camel-quarkus/latest/">Documentation</a>
@@ -101,7 +106,9 @@ This project hosts the efforts to port and package most of
the Camel components
## Camel Spring Boot
-Camel support for Spring Boot provides auto-configuration of the Camel context
by auto-detecting Camel routes available in the Spring context and registers
the key Camel utilities as beans. It also provides starters for the Camel
components.
+Camel support for Spring Boot provides many features for Spring Boot users.
+Including autoconfiguration of the Camel context by auto-detecting Camel
routes available in the Spring context and registers the key Camel utilities as
beans.
+It also provides starters for the Camel components.
<p>
<a class="button dark" href="/camel-spring-boot/latest/">Documentation</a>
@@ -143,7 +150,7 @@ Camel support for Spring Boot provides auto-configuration
of the Camel context b
An Integration Toolkit aimed to increase developer performance through a
graphical user interface to design and configure routes (EIP and REST) using
Kamelets and Components, integration with runtimes and package, image build and
deploy to Kubernetes out-of-the-box.
-Being deployed in Kubernetes Karavan helps to manage projects, design and
monitor integrations, Tekton pipeline to build and deploy integrations.
+Being deployed in Kubernetes, Karavan helps to manage projects, design and
monitor integrations, Tekton pipeline to build and deploy integrations.
[Karavan VS Code
Extension](https://marketplace.visualstudio.com/items?itemName=camel-karavan.karavan)
is integrated with [Camel Jbang](/manual/camel-jbang.html) runtime for fast
local development cycles.
@@ -163,7 +170,7 @@ Being deployed in Kubernetes Karavan helps to manage
projects, design and monito
## Camel JBang
-Camel CLI (Command Line Interface) to easily install and get started with
Apache Camel,
+A Camel CLI (Command Line Interface) to easily install and get started with
Apache Camel,
in only a few minutes. Camel JBang is excellent for no-code/low-code use-cases
and
when you need to quickly build a prototype with Camel.
