This is an automated email from the ASF dual-hosted git repository.
davsclaus 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 df0533e CAMEL-14004 Update the documentation on how to edit the
website (#3299)
df0533e is described below
commit df0533e41112db51412f20027bb247d24f0efb49
Author: Alexandre Kieling <alex.kiel...@gmail.com>
AuthorDate: Thu Oct 31 01:05:19 2019 -0300
CAMEL-14004 Update the documentation on how to edit the website (#3299)
---
.../ROOT/pages/faq/how-do-i-edit-the-website.adoc | 43 ++++++++++++++++------
1 file changed, 32 insertions(+), 11 deletions(-)
diff --git
a/docs/user-manual/modules/ROOT/pages/faq/how-do-i-edit-the-website.adoc
b/docs/user-manual/modules/ROOT/pages/faq/how-do-i-edit-the-website.adoc
index e8f84a6..99bd70a0 100644
--- a/docs/user-manual/modules/ROOT/pages/faq/how-do-i-edit-the-website.adoc
+++ b/docs/user-manual/modules/ROOT/pages/faq/how-do-i-edit-the-website.adoc
@@ -1,18 +1,39 @@
[[HowdoIeditthewebsite-HowdoIeditthewebsite]]
= How do I edit the website?
-The website is all contained in
-https://github.com/apache/camel/[the GitHub repository] so that you can
-xref:contributing.adoc[contribute] providing you are happy to license
-all your contributions under the
-http://www.apache.org/licenses/LICENSE-2.0[Apache Software License version 2.0]
+There are two ways to edit the website:
-[[HowdoIeditthewebsite-Howtoedit]]
-== How to edit
+* Directly on the GitHub website
+* In local repositories
-TODO: Write how it works and how to contribute to the web site.
+NOTE: All contributions are licensed under the
http://www.apache.org/licenses/LICENSE-2.0[Apache Software License version 2.0]
-[[HowdoIeditthewebsite-Howthesiteworks]]
-== How the site works
+== Directly on the GitHub website
-TODO: Write how it works and how to contribute to the web site.
+The website pages can be edited on the GitHub website. It's a very quick
process and ideal for fixing typos or updating information.
+
+Steps to edit a file:
+
+. Go to the page you want to edit.
+. Look for a link called "Edit this Page" and click on it.
+. Edit the file.
+. Preview your changes.
+. Provide a title and description for your pull request.
+. Click on the "Propose file change" button.
+
+== In local repositories
+
+To edit files locally, it's important to understand how the website is
generated and where the files are located. The
https://github.com/apache/camel-website[site generator] is located in its own
repository. The documentation is located in the main
https://github.com/apache/camel[Apache Camel] repository and sub-project
repositories, such as https://github.com/apache/camel-k[Camel-K] and
https://github.com/apache/camel-quarkus[Camel Quarkus]. Have a look at the
xref:how-does-the-website- [...]
+
+Steps to edit a file:
+
+. Fork and clone the https://github.com/apache/camel-website[site generator
repository] and the Camel repository that contains the documentation you want
to change.
+. Follow the build instructions located in the site generator's
https://github.com/apache/camel-website/blob/master/README.md[README file].
+. Open Antora's
https://github.com/apache/camel-website/blob/master/site.yml[`site.yml`]
configuration file and change the content sources to
https://docs.antora.org/antora/2.1/playbook/configure-content-sources/#local-urls[local
repositories].
+. Edit the file.
+. Build the website.
+. Preview your changes locally.
+. Revert changes to `site.yml`.
+. Push your changes to your forked repositories and send a pull request.
+
+NOTE: It's a good idea to spend some time and learn how
https://antora.org[Antora] and https://gohugo.io/[Hugo] work.
