[
https://issues.apache.org/jira/browse/CAMEL-11501?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16720124#comment-16720124
]
Zoran Regvart commented on CAMEL-11501:
---------------------------------------
We should add more text to the [website
README|https://github.com/apache/camel-website/blob/master/README.md],
detailing how the website is built using Antora and Hugo, explain the
significance of the Camel Anotora UI theme and where to go to contribute to
different parts of the website (components reference and manual are in the
camel git repository, the rest is in the camel-website git repository). It
should also include how to live preview the content/design changes locally.
There's [one
README|https://github.com/apache/camel-website/blob/master/antora-ui-camel/README.adoc]
in the Camel Antora UI theme that's copied over from the default Antora theme
we should update it to not point to Antora default theme (Gitlab pipeline
build). We should note that that part was taken from the Antora project under
the MPL license, similar to how Couchbase theme has in it's [own
README|https://github.com/apache/camel-website/blob/master/antora-ui-camel/README.adoc#copyright-and-license].
We need a README in the [docs directory of the camel git
repository|https://github.com/apache/camel/tree/website/docs] explaining the
purpose of the Gulp build there and how the content there is included in the
website.
> Create readme
> -------------
>
> Key: CAMEL-11501
> URL: https://issues.apache.org/jira/browse/CAMEL-11501
> Project: Camel
> Issue Type: Sub-task
> Components: website
> Reporter: Zoran Regvart
> Priority: Major
> Labels: help-wanted
>
> There should be a readme file to explain how the website is organized and how
> to build and contribute to the website.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
