Skip to content

Commit

Permalink
Improve landing page (#3563)
Browse files Browse the repository at this point in the history
* 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 <mail@maximilian-kolb.de>
  • Loading branch information
aneta-petrova and maximiliankolb authored Jan 15, 2025
1 parent 73152cf commit a600aab
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 20 deletions.
44 changes: 27 additions & 17 deletions web/content/index.adoc.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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 %>
2 changes: 1 addition & 1 deletion web/content/js/nav.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ function buildNavigation() {
<span></span>
</button>
<ul class="nav-menu">
<li class="nav-item"><a href="/">Home</a></li>`
<li class="nav-item"><a href="https://theforeman.org/">About Foreman</a></li>`
+ navBuilds.map(function(build){
return(
`<li class="nav-item dropdown">
Expand Down
2 changes: 0 additions & 2 deletions web/layouts/default.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
<%= render "/nav.html.erb" %>
<div class="container narrow">
<%= yield %>
This is work-in-progress documentation site for <a href="https://www.theforeman.org">Foreman</a> open-source software and its plugins.
Official documentation <a href="https://theforeman.org/manuals/latest/index.html">is available here</a>.
</div>
</body>
</html>

0 comments on commit a600aab

Please sign in to comment.