zregvart commented on a change in pull request #397: URL: https://github.com/apache/camel-website/pull/397#discussion_r441811045
########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects --- -{{< div "project" >}} +{{< div "camel-project" >}} [](/manual/latest/) -## Camel +## Apache Camel Documentation Review comment: The heading is not only about the documentation, so it doesn't seem like having _Documentation_ there is appropriate. I'd keep this as Camel, or perhaps "Camel Core" or even remove it, the logo could be saying enough. ########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects Review comment: Having a title seems a bit awkward, I'd remove it here from the front matter and use [`with`](https://gohugo.io/functions/with#readout) here: https://github.com/apache/camel-website/blob/d33c1fe6bfd1444a6727f398363e978c3fc35962/layouts/_default/single.html#L7 ########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects --- -{{< div "project" >}} +{{< div "camel-project" >}} [](/manual/latest/) -## Camel +## Apache Camel Documentation + +{{< div "camel-documentation" >}} + +{{< div "project" >}} + +### User Manual + +{{< div "description" >}} + +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). + +{{< /div >}} + +{{< /div >}} + +{{< div "project" >}} + +### Components {{< div "description" >}} -Apache Camel is the Swiss knife of integration. It is an open source integration framework that is packed with several hundred components that are used to access databases, message queues and APIs, helping you integrate with everything. +Component references are references used to place a component in an assembly. Apache Camel [Component reference](/components/latest/) list is auto generated from the code to reflect the configuration options and functionality available in a particular Camel version. + +{{< /div >}} {{< /div >}} {{< div "links" >}} -[Examples](https://github.com/apache/camel-examples/tree/master/examples) | -[Documentation](/manual/latest/) | -[Source](https://github.com/apache/camel/) +[Full User Manual](/manual/latest/) | +[Getting Started](/manual/latest/getting-started.html) | +[Component Reference](/components/latest/) | Review comment: We can put the API documentation here ```suggestion [Component Reference](/components/latest/) | [API Documentation](https://www.javadoc.io/doc/org.apache.camel/camel-api/latest/index.html) | ``` ########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects --- -{{< div "project" >}} +{{< div "camel-project" >}} [](/manual/latest/) -## Camel +## Apache Camel Documentation + +{{< div "camel-documentation" >}} + +{{< div "project" >}} + +### User Manual + +{{< div "description" >}} + +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). + +{{< /div >}} + +{{< /div >}} + +{{< div "project" >}} + +### Components {{< div "description" >}} -Apache Camel is the Swiss knife of integration. It is an open source integration framework that is packed with several hundred components that are used to access databases, message queues and APIs, helping you integrate with everything. +Component references are references used to place a component in an assembly. Apache Camel [Component reference](/components/latest/) list is auto generated from the code to reflect the configuration options and functionality available in a particular Camel version. + +{{< /div >}} {{< /div >}} {{< div "links" >}} -[Examples](https://github.com/apache/camel-examples/tree/master/examples) | -[Documentation](/manual/latest/) | -[Source](https://github.com/apache/camel/) +[Full User Manual](/manual/latest/) | +[Getting Started](/manual/latest/getting-started.html) | Review comment: Not sure if we need the "Getting Started", it's part of the manual, so it might not be needed. ########## File path: config.toml ########## @@ -42,12 +42,6 @@ timeout = 300000 identifier = "projects" url = "/projects/" -[[menu.main]] - name = "Documentation" - identifier = "docs" - weight = 4 - url = "/docs/" - Review comment: Remember that we need to add redirect if we remove a URL, in this case `/docs*` should redirect to `/projects/`, this needs to be added to `.htaccess` file like this: https://github.com/apache/camel-website/blob/d33c1fe6bfd1444a6727f398363e978c3fc35962/static/.htaccess#L1108 This is to prevent folk landing on 404 page. This should be done with https://httpd.apache.org/docs/2.4/mod/mod_alias.html#redirectmatch as in this case under `/docs` we have three pages. ########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects --- -{{< div "project" >}} +{{< div "camel-project" >}} [](/manual/latest/) -## Camel +## Apache Camel Documentation + +{{< div "camel-documentation" >}} + +{{< div "project" >}} + +### User Manual + +{{< div "description" >}} + +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). + +{{< /div >}} + +{{< /div >}} + +{{< div "project" >}} + +### Components {{< div "description" >}} -Apache Camel is the Swiss knife of integration. It is an open source integration framework that is packed with several hundred components that are used to access databases, message queues and APIs, helping you integrate with everything. +Component references are references used to place a component in an assembly. Apache Camel [Component reference](/components/latest/) list is auto generated from the code to reflect the configuration options and functionality available in a particular Camel version. Review comment: Perhaps something like: ```suggestion Camel is packed with several hundred components that are used to access databases, message queues and APIs, in the [Component reference](/components/latest/) you can read about functionality and configuration of each component. ``` ########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects --- -{{< div "project" >}} +{{< div "camel-project" >}} [](/manual/latest/) -## Camel +## Apache Camel Documentation + +{{< div "camel-documentation" >}} + +{{< div "project" >}} + +### User Manual + +{{< div "description" >}} + +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). + +{{< /div >}} + +{{< /div >}} + +{{< div "project" >}} + +### Components {{< div "description" >}} -Apache Camel is the Swiss knife of integration. It is an open source integration framework that is packed with several hundred components that are used to access databases, message queues and APIs, helping you integrate with everything. +Component references are references used to place a component in an assembly. Apache Camel [Component reference](/components/latest/) list is auto generated from the code to reflect the configuration options and functionality available in a particular Camel version. + +{{< /div >}} {{< /div >}} {{< div "links" >}} -[Examples](https://github.com/apache/camel-examples/tree/master/examples) | -[Documentation](/manual/latest/) | -[Source](https://github.com/apache/camel/) +[Full User Manual](/manual/latest/) | Review comment: We only have one version of the manual, no need to call it _Full_ ```suggestion [User Manual](/manual/latest/) | ``` ########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects --- -{{< div "project" >}} +{{< div "camel-project" >}} [](/manual/latest/) -## Camel +## Apache Camel Documentation + +{{< div "camel-documentation" >}} + +{{< div "project" >}} + +### User Manual + +{{< div "description" >}} + +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). + +{{< /div >}} + +{{< /div >}} + +{{< div "project" >}} + +### Components {{< div "description" >}} -Apache Camel is the Swiss knife of integration. It is an open source integration framework that is packed with several hundred components that are used to access databases, message queues and APIs, helping you integrate with everything. +Component references are references used to place a component in an assembly. Apache Camel [Component reference](/components/latest/) list is auto generated from the code to reflect the configuration options and functionality available in a particular Camel version. + +{{< /div >}} {{< /div >}} {{< div "links" >}} -[Examples](https://github.com/apache/camel-examples/tree/master/examples) | -[Documentation](/manual/latest/) | -[Source](https://github.com/apache/camel/) +[Full User Manual](/manual/latest/) | +[Getting Started](/manual/latest/getting-started.html) | +[Component Reference](/components/latest/) | +[Source Code](https://github.com/apache/camel/) Review comment: We also have examples for Camel ```suggestion [Source Code](https://github.com/apache/camel/) | [Examples](https://github.com/apache/camel-examples/) ``` ########## File path: content/projects/_index.md ########## @@ -2,28 +2,50 @@ title: Apache Camel Projects --- -{{< div "project" >}} +{{< div "camel-project" >}} [](/manual/latest/) -## Camel +## Apache Camel Documentation + +{{< div "camel-documentation" >}} + +{{< div "project" >}} + +### User Manual + +{{< div "description" >}} + +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). + +{{< /div >}} + +{{< /div >}} + +{{< div "project" >}} + +### Components {{< div "description" >}} -Apache Camel is the Swiss knife of integration. It is an open source integration framework that is packed with several hundred components that are used to access databases, message queues and APIs, helping you integrate with everything. +Component references are references used to place a component in an assembly. Apache Camel [Component reference](/components/latest/) list is auto generated from the code to reflect the configuration options and functionality available in a particular Camel version. + +{{< /div >}} {{< /div >}} {{< div "links" >}} -[Examples](https://github.com/apache/camel-examples/tree/master/examples) | -[Documentation](/manual/latest/) | -[Source](https://github.com/apache/camel/) +[Full User Manual](/manual/latest/) | +[Getting Started](/manual/latest/getting-started.html) | +[Component Reference](/components/latest/) | +[Source Code](https://github.com/apache/camel/) {{< /div >}} {{< /div >}} +{{< /div >}} Review comment: Thought, but here it is very prominent, indent the `div`s so it's easier to follow the nesting. ########## File path: antora-ui-camel/src/css/projects.css ########## @@ -2,6 +2,21 @@ text-align: center; } +.projects .camel-project { + width: 96%; Review comment: I think this can probably be something like `width: calc(100% - 2rem)` or similar, these percentages look a bit hacky, having a more explicit definition shows the intent clearer. ########## File path: content/projects/_index.md ########## @@ -137,4 +159,22 @@ Camel support for Spring Boot provides auto-configuration of the Camel context b {{< /div >}} +{{< div "project" >}} + +[](/manual/latest/) + +## Camel APIs + +{{< div "description" >}} + +Apache Camel provides several APIs for Camel cloud service, Camel cluster support, Camel health check support etc. Apache camel maintains JavaDoc documentation for all APIs. + +{{< /div >}} + +{{< div "links" >}} + +[API JavaDoc Documentation](https://www.javadoc.io/doc/org.apache.camel/camel-api/latest/index.html) + +{{< /div >}} +{{< /div >}} Review comment: I don't think this merits a separate section ```suggestion ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org