Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-order sub projects in version picker popup menu in the website #692

Open
davsclaus opened this issue Nov 28, 2021 · 4 comments
Open

Re-order sub projects in version picker popup menu in the website #692

davsclaus opened this issue Nov 28, 2021 · 4 comments

Comments

@davsclaus
Copy link
Contributor

In the bottom left corner you can choose versions of docs. However the order should be improved

User Manual
Components
Camel Spring Boot
Camel Quarkus
Camel K
Camel Kafka Connector
Camel Karaf
Kamelet Catalog

@davsclaus
Copy link
Contributor Author

Screenshot 2021-11-28 at 10 14 27

@djencks
Copy link
Contributor

djencks commented Nov 28, 2021

I don't see the principles behind your suggested ordering. Here are my thoughts:

user manual -explains what camel is all about, needs to be first
camel - camel core, needs to be next, everything else depends on it.
...
kamelets - IIUC this is a generic way of representing partial configurations of one or more camel components, usable in several environments. This is qualitatively different from everything else, and it makes sense to me to put it at the end.


Everything else.... IIUC these are ways of running camel components in different environments, with various degrees of generated and hand-written wrapper code. I can think of two reasonable orderings:

  • alphabetical, yielding what we have now except with kamelets at the end.
  • by increasing amount of generated and hand-written wrapper code. I'm not sure but I think this would yield something like

Camel-Karaf
Camel-Spring-Boot
Camel-K
Camel-Kafka-Connector
Camel-Quarkus

How did you select the ordering of these items?

@davsclaus
Copy link
Contributor Author

Where is the source code for the version picker?

@djencks
Copy link
Contributor

djencks commented Nov 30, 2021

The version picker itself is antora-ui-camel/src/partials/nav-explore.hbs

The code for ordering the components is in antora-ui-camel and is kind of spread out between
src/partials/nav-explore.hbs:

    {{#each (exclude (order_components site.components) 'camel-quarkus-examples')}}

and
src/helpers/order_components.js

I wrote an article on how to do this... https://blog.yuzutech.fr/blog/sort-antora-components/index.html, possibly using a more configurable approach such as I suggest might be useful.

Before making any changes I hope you'll explain your reasoning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants