From a600aab81a7f7f6a0571340f6a976c88a3bae215 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aneta=20=C5=A0teflov=C3=A1=20Petrov=C3=A1?= Date: Wed, 15 Jan 2025 14:36:33 +0100 Subject: [PATCH] Improve landing page (#3563) * Add info block * Add a link to Foreman site * Drop Home from navigation (duplicates the logo link) * Rephrase the descriptions on the page --------- Co-authored-by: Maximilian Kolb --- web/content/index.adoc.erb | 44 ++++++++++++++++++++++-------------- web/content/js/nav.js | 2 +- web/layouts/default.html.erb | 2 -- 3 files changed, 28 insertions(+), 20 deletions(-) diff --git a/web/content/index.adoc.erb b/web/content/index.adoc.erb index 4946058e3a1..c6222f82a96 100644 --- a/web/content/index.adoc.erb +++ b/web/content/index.adoc.erb @@ -2,42 +2,52 @@ title: Home --- -== Foreman and Katello Documentation +[INFO] +==== +The link:docs.theforeman.org[] documentation site is work in progress. +Some guides are not yet available for all flavors and some content might be missing. +See link:https://github.com/theforeman/foreman-documentation/milestone/3[related GitHub milestone] for details on our progress. -The documentation is differentiated into the following flavors: +For official documentation, see link:https://theforeman.org/manuals/latest/index.html[Foreman Manual]. +For Foreman plugin overview, see link:https://theforeman.org/plugins/[Plugins]. +==== -* Foreman on Enterprise Linux (EL) without the Katello plugin -* Foreman on Debian/Ubuntu without the Katello plugin -* Foreman on Enterprise Linux (EL) with the Katello plugin +== Navigating the docs.theforeman.org site -Select the required flavor in the top menu. -The documentation is work in progress and not all guides are available for all flavors yet. +Use the top menu bar to select your release version and flavor. For questions, visit the https://community.theforeman.org/c/support/10[support forum]. For contribution, visit the https://github.com/theforeman/foreman-documentation[GitHub repository]. +=== Available flavors + +We provide documentation for the following flavors: + +* Foreman on Enterprise Linux (EL) +* Foreman on Debian/Ubuntu +* Foreman with the Katello plugin on Enterprise Linux (EL) + === Supported releases -The following releases are supported, meaning they receive (security) updates. +The following releases are supported and receive updates, including security updates: <% releases_in_state('supported').each do |release| %> * link:<%= release.path %>[<%= release[:title] %>] <% end %> -=== Unsupported releases +[IMPORTANT] +==== +If you are currently using one of the unsupported earlier releases, we recommend you to update to a supported release. +==== + +=== Pre-release versions -The future version is built in nightly. +The future version is built in nightly: * link:/release/nightly/[Nightly] <% if (release = releases_in_state('RC').first) %> -There is a release candidate available for testing. - -* link:<%= release.path %>[<%= release[:title] %>] -<% end %> - -These releases are unsupported and no longer receive updates. Users should update to a supported release. +A release candidate is available for testing: -<% releases_in_state('unsupported').each do |release| %> * link:<%= release.path %>[<%= release[:title] %>] <% end %> diff --git a/web/content/js/nav.js b/web/content/js/nav.js index e42d9abe09c..e6d24344d07 100644 --- a/web/content/js/nav.js +++ b/web/content/js/nav.js @@ -22,7 +22,7 @@ function buildNavigation() {