This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new db0b168 Contributing docs: Removed the wiki part
db0b168 is described below
commit db0b16856a39a3337cec5e1471aa8affac0868a8
Author: Andrea Cosentino <[email protected]>
AuthorDate: Thu May 16 12:51:15 2019 +0200
Contributing docs: Removed the wiki part
---
CONTRIBUTING.md | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 99c22e9..d34f9e7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -39,14 +39,15 @@ There are various ways of communicating with the Camel
community.
Documentation is massively important to help users make the most of Apache
Camel and its probably the area that needs the most help!
So if you are interested in helping the documentation effort; whether its 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!
-Most of the documentation is stored on the wiki. We are currently moving the
documentation into the code (AsciiDoc). From there it is automatically
converted to the wiki. So before editing the wiki check the code because
otherwise your changes may be lost. This transition is work-in-progress.
-
-See [How does the website
work](http://camel.apache.org/how-does-the-website-work.html) or [How do I edit
the website for more
details](http://camel.apache.org/how-do-i-edit-the-website.html).
-To be able to edit the wiki you need
-- an appropriate licence agreement on file with the ASF
-- an account on the wiki (on the bottom of each page there is an edit button,
that allows you to create an account)
-- karma - mail the dev list asking for permission (to prevent spam we only
offer access to the wiki by folks sending mail to the mailing list).
-
+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
## If you find a bug or problem
