This is an automated email from the ASF dual-hosted git repository. zregvart pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 9dd59996259872a828ffe022dfc42fa8effa3335 Author: klease <[email protected]> AuthorDate: Sun May 9 16:35:51 2021 +0200 CAMEL-16576: Remove contributing section from user manual The CONTRIBUTING.md page in the repostiory is shortened and links to the contributing page in the Community section (now in camel-website). Links in user manual and faq content and navigation are adjusted. --- CONTRIBUTING.md | 169 ++-------------- docs/user-manual/modules/ROOT/nav.adoc | 6 +- .../modules/ROOT/pages/configuring-camel.adoc | 2 +- .../modules/ROOT/pages/contributing.adoc | 222 --------------------- .../ROOT/pages/improving-the-documentation.adoc | 26 +++ docs/user-manual/modules/ROOT/pages/index.adoc | 12 -- .../faq/pages/how-do-i-become-a-committer.adoc | 2 +- .../faq/pages/how-does-the-website-work.adoc | 2 +- docs/user-manual/modules/faq/pages/index.adoc | 2 +- 9 files changed, 45 insertions(+), 398 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92a1477..51f87ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,167 +1,24 @@ ## Contributing to Apache Camel +First of all, thank you for having an interest in contributing to Apache Camel. +If this is your first contribution to Camel, please review [the guidelines for contributing to Camel and its related projects](https://camel.apache.org/community/contributing/). +For more details about the process of building and testing, please also check the [Contributing section](https://camel.apache.org/manual/latest/contributing.html) in the Documentation on the Apache Camel website. -There are many ways you can help make Camel a better piece of software - please dive in and help! -- Try surfing the documentation - if something confuses you, bring it to our attention. -- Download the code & try it out and see what you think. -- Browse the source code. Got an itch to scratch, want to tune some operation, or add some feature? -- Want to do some hacking on Camel? Try surfing our [issue tracker](https://issues.apache.org/jira/browse/CAMEL) for open issues or features that need to be implemented, take active ownership of a particular issue, and try to fix it. -- If you are a new Camel rider and would like to help us, you can also find [some easy to resolve issues.](https://issues.apache.org/jira/issues/?filter=12348074) -- Leave a comment on the issue to let us know you are working on it, and add yourself as a watcher to get informed about all modifications. +Then follow these simple guidlines for working on the code. +- Fork and then clone the github camel repository: + git clone https://github.com/your-github-username*/camel.git -## Table of Contents - -- [Getting in touch](#getting-in-touch) -- [Improving the documentation](#improving-the-documentation) -- [If you find a bug or problem](#if-you-find-a-bug-or-problem) -- [Working on the code](#working-on-the-code) -- [Running checkstyle](#running-checkstyle) -- [Verify Karaf features](#verify-karaf-features) -- [Apache Camel committers should work on the ASF git repo](#apache-camel-committers-should-work-on-the-asf-git-repo) -- [Creating patches](#creating-patches) -- [Pull request at Github](#pull-request-at-github) -- [Manual patch files](#manual-patch-files) -- [Submitting patches](#submitting-patches) -- [Using the issue tracker](#using-the-issue-tracker) -- [Becoming a committer](#becoming-a-committer) - - -## Getting in touch - -There are various ways of communicating with the Camel community. -- Join us on the [Discussion Forums](http://camel.465427.n5.nabble.com) and take part in any conversations -- Pop by on [Zulip](https://camel.zulipchat.com) and say hi - - -## Improving the documentation - -Documentation is massively critical for users intending to make the most of Apache Camel, and it's probably the area that needs the most help! -So if you are interested in helping with the documentation efforts, whether it's just to fix a page here or there, correct a link, or even write a tutorial or improve existing documentation, please dive in and help! -We moved the documentation into the code (AsciiDoc). We are not using the wiki system anymore. - -To edit the documentation: -- It's easy as opening a Pull Request -- You'll find on each component under src/main/docs a .adoc file - - This file contains a static part and a dynamically generated part: the former can be edited directly in the .adoc file, while the latter needs your intervention on the Javadoc - - Once you modify the Javadoc, you'll need to rebuild the component. And, the .adoc file will get automatically updated. - - Create a commit and raise a Pull Request -- If you want to add more documentation, find the respective .adoc in the codebase - -For more information, see [How does the website work](https://camel.apache.org/manual/latest/faq/how-does-the-website-work.html) or [How do I edit the website for more details](https://camel.apache.org/manual/latest/faq/how-do-i-edit-the-website.html). - -## If you find a bug or problem - -Please raise a new issue in our [issue tracker](https://issues.apache.org/jira/browse/CAMEL) -If you can create a JUnit test case, then your issue is more likely to be resolved quicker. -e.g., take a look at some of the existing [unit tests cases](https://github.com/apache/camel/tree/main/core/camel-core/src/test/java/org/apache/camel) - - -## Working on the code - -We recommend working on the code from [github](https://github.com/apache/camel/). - - git clone https://github.com/apache/camel.git - cd camel - -Build the project (fast build). - +- Build the project using maven: mvn clean install -Pfastinstall -If you intend to work on the code and provide patches and other work you want to submit to the Apache Camel project, then you can fork the project on GitHub and work on your fork. Your custom-work needs to be on your self-created branches, which can then be committed and pushed upstream, and then submitted to Apache Camel as PRs (pull requests). You can find many resources online on how to work on GitHub projects and how to submit work to these projects. - -Please avoid unnecessary changes, like reordering methods and fields, which will make your PR easier to review. - - -## Running checkstyle - -Apache Camel source code is using a coding style/format that can -be verified for its compliance using the checkstyle plugin. -To enable source style checking with checkstyle, build Camel with the -Psourcecheck parameter: - - mvn clean install -Psourcecheck - -Please remember to run this check on your code changes before submitting a patch or Github PR. You do not need to run this against the entire project, but only in your modules. Let's say you do some code changes in the camel-ftp component, following which you can run the check from within this directory: +- Add a unit test with assertions for your changes - cd camel-ftp +- Run checkstyle using the sourcecheck profile in maven mvn clean install -Psourcecheck -## Verify Karaf features - -Camel-Karaf now lives in its self repository, so to verify a Karaf feature, you'll need to fork the following [repository](https://github.com/apache/camel-karaf). - -To check a new Karaf feature or an existing one, you should run a verification on the features.xml file. You'll need to follow these steps: -The first thing to be done is running a full build of Camel. Then - - cd platform/karaf/features/ - mvn clean install - -If you modified a component/dataformat or updated a dependency in the main camel repository, you'll first need to build the main camel locally and then run a full build of camel-karaf. - -## Apache Camel committers should work on the ASF git repo - -If you are an Apache Camel committer, then clone the ASF git repo at - - git clone https://gitbox.apache.org/repos/asf/camel.git - cd camel - -or - - git clone https://github.com/apache/camel.git - cd camel - -Build the project (without testing). - - mvn clean install -Dtest=false - -PS: You might need to build multiple times (if you get a build error) because sometimes the maven fails to download all the files. -Then import the projects into your workspace. - - -## Creating patches - -We recommend you create patches as GitHub PRs as it eases our reviewing process enables faster review completion. You do this as any other GitHub project, where you can fork the project, and create a branch where you work on the code, and then commit and push that code to your fork. Then navigate to the Apache Camel GitHub webpage, and you will see that GitHub at the top of the page has a wizard to send your recent work as a PR (pull request). - - -## Pull request at Github - -There is also a Git repository at GitHub which you could fork. Then you submit patches as any other GitHub project - e.g., work on a new feature branch and send a pull request. One of the committers then needs to accept your pull request to bring the code to the ASF codebase. - -When providing code patches, please include the Camel JIRA ticket number in the commit messages. -We favor using the syntax: - - CAMEL-9999: Some message goes here - -## Manual patch files -We gladly accept patches if you can find ways to improve, tune, or fix Camel in some way. - -We recommend using GitHub PRs instead of manual patch files. Especially for larger patches. - -Most IDEs can create nice patches now very easily. e.g., on Eclipse, right-click on a file/directory, and select Team -> Create Patch. Then, save the patch as a file and attach it to the corresponding issue on our [JIRA issue tracker](https://issues.apache.org/jira/browse/CAMEL). -If you prefer working on the command-line, try the following to create the patch: - - diff -u Main.java.orig Main.java >> patchfile.txt - -or - - git diff --no-prefix > patchfile.txt - - -## Submitting patches - -The easiest way to submit a patch is to -- [create a new JIRA issue](https://issues.apache.org/jira/browse/CAMEL) (you will need to register), -- attach the patch or tarball as an attachment (if you create a patch file, but we recommend using GitHub PRs) -- **tick the Patch Attached** button on the issue -We prefer patches to have unit tests as well and that these unit tests have proper assertions as well, so remember to replace your system.out or logging with appropriate assertions. - - -## Using the issue tracker - -Before you can raise an issue in the [issue tracker](https://issues.apache.org/jira/browse/CAMEL), you need to register with it: This is quick & painless. - - -## Becoming a committer +- Check the documentation (.adoc file) for the code which you have modified and update it if required. For example if you have added or modified a component, the documentation files are under the [docs/components](https://github.com/apache/camel/tree/main/docs/components/modules/ROOT/pages) folder. -Once you've got involved as above, we may well invite you to be a committer. See [How do I become a committer](https://camel.apache.org/manual/latest/faq/how-do-i-become-a-committer.html) for more details. +- Write a commit messsage which references the related JIRA or Github issue and includes some detail of your changes +- Push to your fork and create a pull request +- Stay engaged, follow and respond to comments or questions you might be asked. -The first step is contributing to the project; if you want to take that a step forward and become a fellow committer on the project, please check out our [Committer Guide](https://camel.apache.org/manual/latest/faq/how-do-i-become-a-committer.html). diff --git a/docs/user-manual/modules/ROOT/nav.adoc b/docs/user-manual/modules/ROOT/nav.adoc index 360222a..2a3d5b0 100644 --- a/docs/user-manual/modules/ROOT/nav.adoc +++ b/docs/user-manual/modules/ROOT/nav.adoc @@ -26,13 +26,11 @@ ** xref:writing-components.adoc[Writing Components] ** xref:xml-configuration.adoc[XML Configuration] ** xref:xml-reference.adoc[XML Reference] +** xref:release-guide.adoc[Release guide] +** xref:improving-the-documentation.adoc[Improving the Documentation] * xref:migration-and-upgrade.adoc[Migration and Upgrade] ** xref:camel-3-migration-guide.adoc[Camel 2.x to 3.0 Migration Guide] ** xref:camel-3x-upgrade-guide.adoc[Camel 3.x Upgrade Guide] -* Community -** xref:contributing.adoc[Contributing] -** xref:release-guide.adoc[Release guide] -** https://camel.zulipchat.com[Chat room] * xref:architecture.adoc[Architecture] ** xref:async.adoc[Async] ** xref:asynchronous-routing-engine.adoc[Asynchronous Routing Engine] diff --git a/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc b/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc index b818cfc..128b184 100644 --- a/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc +++ b/docs/user-manual/modules/ROOT/pages/configuring-camel.adoc @@ -67,7 +67,7 @@ at `CamelNamespaceHandler` you'll see how we handle the Spring XML stuff (warning it's kinda hairy code to look at :smile:). If you wanted `<fooComponent>` to be a standard part of the core Camel schema then you'd hack that file to add your component & -xref:contributing.adoc[contribute a patch] to the camel XSD. Otherwise +link:/community/contributing/[contribute a patch] to the camel XSD. Otherwise you could write your own namespace & schema if you prefer. [[ConfiguringCamel-PropertyBinding]] diff --git a/docs/user-manual/modules/ROOT/pages/contributing.adoc b/docs/user-manual/modules/ROOT/pages/contributing.adoc deleted file mode 100644 index dce0f07..0000000 --- a/docs/user-manual/modules/ROOT/pages/contributing.adoc +++ /dev/null @@ -1,222 +0,0 @@ -= Contributing to Apache Camel - -First of all, thank you for having an interest in contributing to Apache Camel. - -Here are some guidelines on how to best approach the Apache Camel community and how to best apply yourself. - -There are many ways you can help make Camel better - please dive in and help! - -* Try surf the documentation - if some things are confusing or not clear, let us know. -* Download the code & try it out and see what you think. -* Browse the source code. Got an itch to scratch, want to tune some operation or add some feature? -* Want to do some hacking on Camel? Try surfing our https://issues.apache.org/jira/browse/CAMEL[issue tracker] for open issues or features that need to be implemented. Take ownership of an issue and try to fix it. -* If you are a new Camel rider and would like to help us, you can also find https://issues.apache.org/jira/issues/?filter=12348073[some easy to resolve issues] or issues we https://issues.apache.org/jira/issues/?filter=12348074[need help with]. -* Leave a comment on the issue to let us know you are working on it and add yourself as a watcher to get informed about all modifications. - -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. - -Introduce yourself on the developer's mailing list (see below), tell us what area of work or problem you wish to address in Camel. Create a draft of your solution, this can be simple 1-2 sentences on the change you wish to make. Try to be as specific as you can: include a short description of your intent, what you tried and what didn't work, or what you need help with. The best way of approaching the developers is by describing what you would like to work on and asking specific questions [...] - -We also participate in Google Summer of Code and Outreachy programs, for information about those look at those program websites. If you wish to participate in either of those follow the guidelines and schedule set by those programs. If you are unsure please reach out via official communication channels of those programs, or ask on the developer's mailing list for help. - -== Table of Contents - -* <<getting-in-touch,Getting in touch>> -* <<improving-the-documentation,Improving the documentation>> -* <<if-you-find-a-bug-or-problem,If you find a bug or problem>> -* <<working-on-the-code,Working on the code>> -* <<testing-the-changes,Testing the changes>> -* <<running-checkstyle,Running checkstyle>> -* <<verify-karaf-features,Verify Karaf features>> -* <<apache-camel-committers-should-work-on-the-asf-git-repo,Apache Camel committers should work on the ASF git repo>> -* <<creating-patches,Creating patches>> -* <<pull-request-at-github,Pull request at Github>> -* <<manual-patch-files,Manual patch files>> -* <<submitting-patches,Submitting patches>> -* <<using-the-issue-tracker,Using the issue tracker>> -* <<becoming-a-committer,Becoming a committer>> - -[#getting-in-touch] -== Getting in touch - -Apache Camel is an Apache Software Foundation project, all communication is done in the open on the project mailing lists. You can https://www.apache.org/foundation/mailinglists.html[read more on the reasoning behind this] to get a better understanding of this. - -All communication is subject to the https://www.apache.org/foundation/policies/conduct.html[ASF Code of Conduct]. - -There are various ways of communicating with the Camel community. - -For questions and guidance around contributing subscribe to the developer's mailing list by sending an e-mail to [email protected]. - -We can also be reached on the Zulip chat at https://camel.zulipchat.com. - -We track issues using https://issues.apache.org/jira/browse/CAMEL[ASF Jira], look for https://issues.apache.org/jira/issues/?filter=12348073[some easy to resolve issues] or issues we https://issues.apache.org/jira/issues/?filter=12348074[need help with]. - -After you're ready to contribute create a Pull request to one of the Camel projects you can find under the Apache organization https://github.com/apache?q=camel[on GitHub]. - -Expect that your Pull request will receive a review and that you will need to respond and correspond to that via comments at GitHub. - -== Your first contribution - -Make sure you followed the steps and guidelines outlined in this document. For bigger changes, make sure that you have discussed on the developer's mailing list or in the Jira issue tracker before hand. We love receiving contributions, to get the best response make sure that the reasoning behind the contribution you wish to make is clear: outline the problem and explain your solution for it. - -Be mindful of the source checks, formatting and the structure of the git commit message we abide by. This will help you in getting your contribution accepted. Outline any changes you made but are unaware or unsure of any consequences or side effects. - -Stay engaged, follow and respond to comments or questions you might be asked. - -[#improving-the-documentation] -== Improving the documentation - -Documentation is massively important to help users make the most of Apache Camel and it's probably the area that needs the most help! -So if you are interested in helping the documentation effort; whether it's just to fix a page here or there, correct a link or even write a tutorial or improve what documentation is already there please do dive in and help! -We moved the documentation into the code (AsciiDoc). We are not using the wiki system anymore. - -To edit the documentation: - -* It's easy as opening a Pull Request -* You'll find on each component under src/main/docs an .adoc file - ** This file contains a static part and a dynamically generated part: the former can be edited directly in the .adoc file, while the latter needs your intervention on the javadoc - ** Once you modify the javadoc, you'll need to rebuild the component and the .adoc will be automatically updated - ** Create a commit and raise a Pull Request -* If you want to add more documentation check for .adoc in codebase - -For more information see xref:faq:how-does-the-website-work.adoc[How does the website work] or xref:faq:how-do-i-edit-the-website.adoc[How do I edit the website for more details]. - -[#if-you-find-a-bug-or-problem] -== If you find a bug or problem - -Please raise a new issue on our https://issues.apache.org/jira/browse/CAMEL[JIRA issue tracker]. This way we’ll know when it’s really fixed and we can ensure that the problem stays fixed in future releases. Please describe the bug/issue clearly, and add pictures/screenshots if necessary. If you can create a JUnit test case then your issue is more likely to be resolved quicker. -e.g. take a look at some of the existing https://svn.apache.org/repos/asf/camel/trunk/camel-core/src/test/java/[unit tests cases] - -[#working-on-the-code] -== Working on the code - -We recommend to work on the code from https://github.com/apache/camel/[github]. - - git clone https://github.com/apache/camel.git - cd camel - -Build the project (fast build). - - mvn clean install -Pfastinstall - -If you intend to work on the code and provide patches and other work you want to submit to the Apache Camel project, then you can fork the project on github and work on your own fork. The custom work you do should be done on branches you create, which can then be committed and pushed upstream, and then submitted to Apache Camel as PRs (pull requests). You can find many resources online how to work on github projects and how to submit work to these projects. - - -If you aren't able to build component after adding some new URI parameters due to `Empty doc for option: [OPTION], parent options: <null>` please make sure that you either added properly javadoc for get/set method or description in `@UriPath` annotation. - -[#testing-the-changes] -== Testing the changes - -If you need to implement tests for your changes, you will probably need to handle 3 separate things: simulate the infrastructure -required for the test (ie.: JMS brokers, Kafka, etc), the code changes and the test logic itself. Naturally, there is no rule of -thumb for how the code changes and test logic should be. However, in regard to simulating the test infrastructure, there is a -growing library of reusable components that can be helpful. These components are locate in the test-infra module and provide -support for simulating message brokers, cloud environments, databases and much more. - -Using these components is usually as simple as registering them as JUnit 5 extensions: - - @RegisterExtension - static NatsService service = NatsServiceFactory.createService(); - -Then, you can access the service by using the methods and properties provided by the services. This varies according to each service. - -If you need to implement a new test infra service, check the readme on the test-infra module for additional details. - -[#running-checkstyle] -== Running checkstyle - -Apache Camel source code is using a coding style/format which can be checked whether is complying using the checkstyle plugin. -To enable source style checking with checkstyle, build Camel with the -Psourcecheck parameter - - mvn clean install -Psourcecheck - -Please remember to run this check on your code changes before submitting a patch or github PR. You do not need to run this against the entire project, but for example in the modules you work on. Lets say you do some code changes in the camel-ftp component, then you can run the check from within this directory: - - cd camel-ftp - mvn clean install -Psourcecheck - -[#verify-karaf-features] -== Verify Karaf features - -Camel-Karaf lives now in his own repository, so to verify a Karaf feature you'll need to fork the following https://github.com/apache/camel-karaf[repository]. - -To check a new Karaf feature or an existing one you should run a verification on the features.xml file. You'll need to follow these steps: -First thing to be done is running a full build of Camel. Then - - cd platform/karaf/features/ - mvn clean install - -If you modified a component/dataformat or updated a dependency in the main camel repository, you'll first need to build the main camel locally and then run a full build of camel-karaf. - -[#apache-camel-committers-should-work-on-the-asf-git-repo] -== Apache Camel committers should work on the ASF git repo - -If you are an Apache Camel committer then clone the ASF git repo at - - git clone https://gitbox.apache.org/repos/asf/camel.git - cd camel - -or - - git clone https://github.com/apache/camel.git - cd camel - -Build the project (without testing). - - mvn clean install -Dtest=false - -PS: You might need to build multiple times (if you get a build error) because sometimes maven fails to download all the files. -Then import the projects into your workspace. - -[#creating-patches] -== Creating patches - -We recommend you create patches as github PRs which is much easier for us to accept and work with. You do this as any other github project, where you can fork the project, and create a branch where you work on the code, and then commit and push that code to your fork. Then navigate to the Apache Camel github webpage, and you will see that github in the top of the page has a wizard to send your recent work as a PR (pull request). - -[#pull-request-at-github] -== Pull request at Github - -There is also a Git repository at Github which you could fork. Then you submit patches as any other github project - eg work on a new feature branch and send a pull request. One of the committers then needs to accept your pull request to bring the code to the ASF codebase. After the code has been included into the ASF codebase, you need to close the pull request because we can't do that... - -When providing code patches then please include the Camel JIRA ticket number in the commit messages. -We favor using the syntax: - - CAMEL-9999: Some message goes here - -[#manual-patch-files] -== Manual patch files - -We gladly accept patches if you can find ways to improve, tune or fix Camel in some way. - -We recommend using github PRs instead of manual patch files. Especially for bigger patches. - -Most IDEs can create nice patches now very easily. e.g. in Eclipse just right click on a file/directory and select Team \-> Create Patch. Then just save the patch as a file and attach it to the corresponding issue on our https://issues.apache.org/jira/browse/CAMEL[JIRA issue tracker]. -If you're a command line person try the following to create the patch - - diff -u Main.java.orig Main.java >> patchfile.txt - -or - - git diff --no-prefix > patchfile.txt - -[#submitting-patches] -== Submitting patches - -The easiest way to submit a patch is to - -* https://issues.apache.org/jira/browse/CAMEL[create a new JIRA issue] (you will need to register), -* attach the patch or tarball as an attachment (if you create a patch file, but we recommend using github PRs) -* *tick the Patch Attached* button on the issue -We prefer patches has unit tests as well and that these unit tests have proper assertions as well, so remember to replace your system.out or logging with an assertion instead! - -[#using-the-issue-tracker] -== Using the issue tracker - -Before you can raise an issue in the https://issues.apache.org/jira/browse/CAMEL[issue tracker] you need to register with it. This is quick & painless. - -[#becoming-a-committer] -== Becoming a committer - -Once you've got involved as above, we may well invite you to be a committer. See http://camel.apache.org/how-do-i-become-a-committer.html[How do I become a committer] for more details. - -The first step is contributing to the project; if you want to take that a step forward and become a fellow committer on the project then see the http://activemq.apache.org/becoming-a-committer.html[Committer Guide] diff --git a/docs/user-manual/modules/ROOT/pages/improving-the-documentation.adoc b/docs/user-manual/modules/ROOT/pages/improving-the-documentation.adoc new file mode 100644 index 0000000..6961873 --- /dev/null +++ b/docs/user-manual/modules/ROOT/pages/improving-the-documentation.adoc @@ -0,0 +1,26 @@ += Improving the documentation + + +== Where to find the documentation +All of the documentation accessible in the left-hand navigation panel on the website is managed in the link:https://asciidoc.org/[AsciiDoc format]. The files have the extension .adoc and are managed in the Camel repositories. They are found in two different places in the repositories: + +* In the src/main/docs folder for each component or camel module +* In the /docs/user-manual folder for the User Manual and FAQ pages. + +== Editing the documentation for a component + +* It's easy as opening a Pull Request +* You'll find on each component under src/main/docs an .adoc file + ** This file contains a static part and a dynamically generated part: the former can be edited directly in the .adoc file, while the latter needs your intervention on the javadoc + ** After you modify the javadoc, you'll need to rebuild the component and the .adoc will be automatically updated +* The generated .adoc file can be previewed in a browser using a plugin +* Create a commit and raise a Pull Request + +== Edit the user manual or FAQs + +These .adoc files are edited directly in /docs/user-manual/modules/ROOT/pages and docs/user-manual/modules/faq/pages. +If you add a new page, don't forget to add it to the nav.adoc file which represents the table of contents shown in the left-hand navigation panel in the website. +After editing the file, you will need to raise a Pull Request for your changes. + +For more information see xref:faq:how-do-i-edit-the-website.adoc[How do I edit the website]. + diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc b/docs/user-manual/modules/ROOT/pages/index.adoc index ac30130..86bce1c 100644 --- a/docs/user-manual/modules/ROOT/pages/index.adoc +++ b/docs/user-manual/modules/ROOT/pages/index.adoc @@ -20,7 +20,6 @@ For a deeper and better understanding of Apache Camel, an xref:faq:what-is-camel * <<Overview>> * <<Documentation>> -* <<Community>> * <<Requirements>> * <<Developers>> @@ -142,17 +141,6 @@ camel routes without them knowing Consult the xref:components::index.adoc[components] documentation. -== Community - -* link:/community/support/[Support] -* xref:contributing.adoc[Contributing] -* xref:release-guide.adoc[Release guide] -* link:/community/mailing-list/[Mailing Lists] -* https://camel.zulipchat.com[Chat room] -* link:/community/user-stories/[User Stories] -* link:/community/team/[Team] -* https://github.com/camel-extra/camel-extra[Camel Extra] - == Requirements === Platform Requirements diff --git a/docs/user-manual/modules/faq/pages/how-do-i-become-a-committer.adoc b/docs/user-manual/modules/faq/pages/how-do-i-become-a-committer.adoc index 50a2755..41a9dfc 100644 --- a/docs/user-manual/modules/faq/pages/how-do-i-become-a-committer.adoc +++ b/docs/user-manual/modules/faq/pages/how-do-i-become-a-committer.adoc @@ -2,7 +2,7 @@ = How can I become a committer First of all you need to get involved and -xref:ROOT:contributing.adoc[Contribute] via the mail list, forums, edit the +link:/community/contributing/[Contribute] via the mail list, forums, edit the documentation, work on the issue tracker and submit patches. Once you're contributing and your work is good, one of our diff --git a/docs/user-manual/modules/faq/pages/how-does-the-website-work.adoc b/docs/user-manual/modules/faq/pages/how-does-the-website-work.adoc index 726438c..5463d7e 100644 --- a/docs/user-manual/modules/faq/pages/how-does-the-website-work.adoc +++ b/docs/user-manual/modules/faq/pages/how-does-the-website-work.adoc @@ -5,4 +5,4 @@ This entire website is hosted in https://github.com/apache/camel/[the GitHub repository], and you can send a pull request to help us make the documentation better. -See https://github.com/apache/camel/blob/main/CONTRIBUTING.md#improving-the-documentation[CONTRIBUTING.md] for guidelines on how to contribute to this website. +See xref:ROOT:improving-the-documentation.adoc[Improving the documentation] for guidelines on how to contribute to this website. diff --git a/docs/user-manual/modules/faq/pages/index.adoc b/docs/user-manual/modules/faq/pages/index.adoc index c28cca1..48e5a89 100644 --- a/docs/user-manual/modules/faq/pages/index.adoc +++ b/docs/user-manual/modules/faq/pages/index.adoc @@ -5,7 +5,7 @@ Here are a list of commonly asked questions and answers. If you have any questions which are not on this list, please talk to us on the link:/community/mailing-list/[Mailing Lists]. -We xref:ROOT:contributing.adoc[welcome contributions] and +We link:/community/contributing/[welcome contributions] and this entire website is in xref:how-does-the-website-work.adoc[the GitHub repository you can send a pull request], so please join in and help us make the documentation better!
