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-website.git
commit 0fee8db51dd2ee10e47a1a2fb82547ac7e1150f7 Author: klease <[email protected]> AuthorDate: Sun May 9 16:29:23 2021 +0200 CAMEL-16576: Move contributing page to Community section --- antora-ui-camel/src/partials/footer-content.hbs | 2 +- content/_index.md | 4 ++-- content/blog/2020/03/Outreachy-May2020/index.md | 2 +- content/community/_index.md | 2 +- content/community/contributing.md | 20 ++++++-------------- content/community/support.md | 2 +- content/docs/_index.md | 2 +- content/download/_index.md | 2 +- layouts/partials/footer.html | 2 +- 9 files changed, 15 insertions(+), 23 deletions(-) diff --git a/antora-ui-camel/src/partials/footer-content.hbs b/antora-ui-camel/src/partials/footer-content.hbs index e21aecd..24e5d30 100644 --- a/antora-ui-camel/src/partials/footer-content.hbs +++ b/antora-ui-camel/src/partials/footer-content.hbs @@ -31,7 +31,7 @@ <dl> <dt><label for="footer-toggle-community">Community</label><label for="footer-toggle-community">+</label></dt> <dd><a href="{{siteRootPath}}/community/support/">Support</a></dd> - <dd><a href="{{siteRootPath}}/manual/latest/contributing.html">Contributing</a></dd> + <dd><a href="{{siteRootPath}}/community/contributing/">Contributing</a></dd> <dd><a href="{{siteRootPath}}/community/mailing-list/">Mailing Lists</a></dd> <dd><a href="{{siteRootPath}}/community/user-stories/">User stories</a></dd> <dd><a href="{{siteRootPath}}/community/articles/">Articles</a></dd> diff --git a/content/_index.md b/content/_index.md index 78682ab..fd8a0cf 100644 --- a/content/_index.md +++ b/content/_index.md @@ -220,9 +220,9 @@ Camel is an [Apache Software Foundation](https://www.apache.org) project, availa [Sources](./community/sources/), [mailing lists](./community/mailing-list/), [issue tracker](./community/support/): it's fully open, you can access directly. -We also love contributions: don't hesitate to [contribute](./manual/latest/contributing.html). You can contribute by <a href="https://github.com/apache/camel-website/edit/main/content/_index.md">editing this page</a>! +We also love contributions: don't hesitate to [contribute](./community/contributing/). You can contribute by <a href="https://github.com/apache/camel-website/edit/main/content/_index.md">editing this page</a>! -[Be Involved In The Community](./manual/latest/contributing.html) | [How To Contribute](./manual/latest/contributing.html) +[Be Involved In The Community](./community/contributing/) | [How To Contribute](./community/contributing/) {{< /div >}} diff --git a/content/blog/2020/03/Outreachy-May2020/index.md b/content/blog/2020/03/Outreachy-May2020/index.md index 7e1ffb5..4941a06 100644 --- a/content/blog/2020/03/Outreachy-May2020/index.md +++ b/content/blog/2020/03/Outreachy-May2020/index.md @@ -27,4 +27,4 @@ Apache Camel is a project with a great community, we are here to help, mentor an As part of the application process, all applicants must make at least one contribution to be accepted as an intern for this project. Only applicants who make a contribution will be eligible to be accepted as interns. -Look at the [contributing to Camel page](/manual/latest/contributing.html) for details on how to get started contributing and how to reach out to the Camel community via various communication channels. And look at the [README](https://github.com/apache/camel-website/blob/main/README.md) in the Camel Website repository on how to get started with the website itself. +Look at the [contributing to Camel page](/community/contributing/) for details on how to get started contributing and how to reach out to the Camel community via various communication channels. And look at the [README](https://github.com/apache/camel-website/blob/main/README.md) in the Camel Website repository on how to get started with the website itself. diff --git a/content/community/_index.md b/content/community/_index.md index 4ae6d22..f2dc277 100644 --- a/content/community/_index.md +++ b/content/community/_index.md @@ -50,7 +50,7 @@ One way to get help is to use the Camel mailing lists. This allows the entire co {{< div "icon" >}} -[](/manual/latest/contributing.html) +[](/community/contributing/) {{< /div >}} diff --git a/content/community/contributing.md b/content/community/contributing.md index c4e9aca..5be8da3 100644 --- a/content/community/contributing.md +++ b/content/community/contributing.md @@ -4,7 +4,7 @@ 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 a better piece of software - please dive in and help! -- Try surfing the documentation - if something confuses you, [bring it to our attention](/manual/latest/improving-the-documentation.html). +- Try surfing the documentation - if something confuses you, [bring it to our attention or suggest an improvement](#working-on-the-documentation). - 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 ownership of a particular issue, and try to fix it. @@ -13,22 +13,10 @@ There are many ways you can help make Camel a better piece of software - please 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 [...] +Introduce yourself on the [developer's mailing list] (#getting-in-touch), 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 [...] 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) -- [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) -- [Creating patches](#creating-patches) -- [Submitting your contribution](#submitting-your-contribution) -- [Becoming a committer](#becoming-a-committer) - - ## 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 [read more on the reasoning behind this](https://www.apache.org/foundation/mailinglists.html) to get a better understanding of this. @@ -49,6 +37,10 @@ For examples, take a look at some of the existing [unit test cases](https://gith **NOTE:** you will need to register to create or comment on JIRA issues. The "Log In" link in the upper right will allow you to login with an existing account or sign up for an account. +## Working on the documentation + +Documentation is extremely 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 existing documentation please do dive in and help! Most of the documentation is managed in the same repositories as the related source code so the process is similar to working on the code. For more details please refer to [Improving the documentation in the User Manual](/manual/latest/improving-the-documentation.html). ## Working on the code diff --git a/content/community/support.md b/content/community/support.md index e16ba19..260704f 100644 --- a/content/community/support.md +++ b/content/community/support.md @@ -66,7 +66,7 @@ What version of Camel do you use? Remember to include this information. 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](/manual/latest/contributing.html) fixing the bug! (We also buy you beer when we meet you if you submit bug fixes (smile) ) +* [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. ## Commercial Support diff --git a/content/docs/_index.md b/content/docs/_index.md index 60f0138..9ea0284 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -13,7 +13,7 @@ Title: "Documentation" ## Camel Core -The [User Manual](/manual/latest/) is a comprehensive guide meant to help you with the key concepts of Apache Camel and software integration, from how to [begin contributing](/manual/latest/contributing.html) to Apache Camel, how to [upgrade to Camel 3.x](/manual/latest/camel-3x-upgrade-guide.html), to [architecture](/manual/latest/architecture.html) or [integration patterns](/components/latest/eips/enterprise-integration-patterns.html). +The [User Manual](/manual/latest/) is a comprehensive guide meant to help you with the key concepts of Apache Camel and software integration, from how to [get started](/manual/latest/getting-started.html) with Apache Camel, how to [upgrade to Camel 3.x](/manual/latest/camel-3x-upgrade-guide.html), to [architecture](/manual/latest/architecture.html) or [integration patterns](/components/latest/eips/enterprise-integration-patterns.html). <p> <a class="button dark" href="/manual/latest/">Documentation</a> diff --git a/content/download/_index.md b/content/download/_index.md index 06c9692..389d77c 100644 --- a/content/download/_index.md +++ b/content/download/_index.md @@ -6,7 +6,7 @@ We do frequent releases, a release almost every month, and even though we strive Unless you need the latest features, you might consider using a Long Term Support (LTS) version that will receive bug and security fixes for a longer time - up to one year. -A good strategy to prepare for future LTS releases might be to test the latest releases. You can do this on less impactful projects or by running tests of your codebase against newer releases. Please do [report any issues](/manual/latest/contributing.html#using-the-issue-tracker) with functionality or backward compatibility so they can be addressed in time for the LTS version. +A good strategy to prepare for future LTS releases might be to test the latest releases. You can do this on less impactful projects or by running tests of your codebase against newer releases. Please do [report any issues](/community/contributing/#if-you-find-a-bug-or-problem) with functionality or backward compatibility so they can be addressed in time for the LTS version. For information on the release planning look at the blog posts in the [Roadmap](/categories/Roadmap/) category. diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 15f674f..312bb49 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -34,7 +34,7 @@ <dl> <dt><label for="footer-toggle-community">Community</label><label for="footer-toggle-community">+</label></dt> <dd><a href="/community/support/">Support</a></dd> - <dd><a href="/manual/latest/contributing.html">Contributing</a></dd> + <dd><a href="/community/contributing/">Contributing</a></dd> <dd><a href="/community/mailing-list">Mailing Lists</a></dd> <dd><a href="/community/user-stories/">User stories</a></dd> <dd><a href="/community/articles/">Articles</a></dd>
