Hi Karen, thank you for doing the analysis and for the very thoughtful plan. Replies are inline.
On Wed, Apr 28, 2021 at 11:56 AM Karen Lease <karenlease...@gmail.com> wrote: [snip] > 1. Compare & merge more recent changes from adoc files to md files and > remove the .adoc files. +1, I prefer the manual to be focused on using Camel, and the community bits outside of the manual > 2. Change links in the user manual navigation, assuming we want to > reference those pages in the user manual. +1, I think, since we have the top menu for Community we can also remove these from the manual. Those are in docs/user-manual/modules/ROOT/nav.adoc of the apache/camel repository on GitHub > 3. Change the footer link to mailing-list to reference the md page > instead of the adoc page. +1, two changes are needed, due to using Antora and Hugo to build the website we have two sets of templates, in: antora-ui-camel/src/partials/footer-content.hbs and layouts/partials/footer.html of the apache/camel-website repository on GitHub > 4. Possibly add a Mailing List section to the main Community page to be > consistent with the Footer link. It is linked from the Support page already. +1, folk often miss the mailing list I think, this would help more folk in finding it. > 5. Check and fix embedded links to the user manual pages which would be > replaced with the pages generated from the .md files. As far as I can > tell, there aren't too many. +1, we have a link checker in the website run with `yarn check:links`, it'll check all site relative links, and another checker (run with yarn check:html) forbids links to camel.apache.org that are not site relative. I suspect there might be a fair bit of xref links to the community from the user manual or perhaps from components or sub projects as well. Hopefully the checks will catch them all. > What's your feedback on this plan? Sounds like you have a very clear understanding of what we need fixed. Please do reach out if you find any issues or need any help with this. Thanks! zoran -- Zoran Regvart
