From 76e1377775a20756c985186be37cd4c8ad0b30a1 Mon Sep 17 00:00:00 2001 From: Justin W. Flory (he/him) Date: Sep 20 2020 22:38:45 +0000 Subject: [PATCH 1/2] Navigation: Add navigation bar for Status Dashboard This commit adds a navigation bar and also a sublink to the guide page on how to use and interpret the Status Dashboard. I was disoriented at first to not see anything in the navbar. Signed-off-by: Justin W. Flory (he/him) --- diff --git a/antora.yml b/antora.yml index 53c2187..0cba234 100644 --- a/antora.yml +++ b/antora.yml @@ -1,6 +1,12 @@ +--- # Name will be mostly visible in the URL. Treat it as an indentifier. # Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page) name: project # <---- PLEASE MODIFY # If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version. version: master + +# This lists all the menu definitions of your component. +nav: + - modules/ROOT/nav.adoc + - modules/dashboard/nav.adoc diff --git a/modules/dashboard/nav.adoc b/modules/dashboard/nav.adoc index e69de29..cf354e8 100644 --- a/modules/dashboard/nav.adoc +++ b/modules/dashboard/nav.adoc @@ -0,0 +1,2 @@ +* xref:index.adoc[Status Dashboard] +** xref:guide.adoc[Dashboard guide] diff --git a/modules/dashboard/pages/index.adoc b/modules/dashboard/pages/index.adoc index d94efd7..d771039 100644 --- a/modules/dashboard/pages/index.adoc +++ b/modules/dashboard/pages/index.adoc @@ -1,21 +1,32 @@ -= Fedora Project Status += Status Dashboard This dashboard tracks the high-level status of link:https://docs.fedoraproject.org/en-US/project/objectives/[Fedora Objectives], link:https://fedoraproject.org/wiki/Editions[Fedora Editions], and Fedora Council representatives. This is not a technical status dashboard. https://docs.fedoraproject.org/en-US/project/dashboard/guide/[Guidance] for status report writers is available. -= Council Representatives + +[[council]] +== Council Representatives + include::council/diversity_inclusion.adoc[leveloffset=+2] ''' include::council/engineering.adoc[leveloffset=+2] ''' include::council/mindshare.adoc[leveloffset=+2] -= Objectives + + +[[objectives]] +== Objectives + include::objectives/iot.adoc[leveloffset=+2] ''' include::objectives/minimization.adoc[leveloffset=+2] -= Editions + + +[[editions]] +== Editions + include::editions/fcos.adoc[leveloffset=+1] ''' include::editions/server.adoc[leveloffset=+1] From ff3550b30518a58bc4f97ff34ef68e4adbe3db8e Mon Sep 17 00:00:00 2001 From: Justin W. Flory (he/him) Date: Sep 20 2020 22:38:45 +0000 Subject: [PATCH 2/2] index: Add Table of Contents This adds a table of contents at the top of the page. I think this makes content easier to discover, especially as the page grows longer. Signed-off-by: Justin W. Flory (he/him) --- diff --git a/modules/dashboard/pages/index.adoc b/modules/dashboard/pages/index.adoc index d771039..8ee4652 100644 --- a/modules/dashboard/pages/index.adoc +++ b/modules/dashboard/pages/index.adoc @@ -1,4 +1,5 @@ = Status Dashboard +:toc: This dashboard tracks the high-level status of link:https://docs.fedoraproject.org/en-US/project/objectives/[Fedora Objectives], link:https://fedoraproject.org/wiki/Editions[Fedora Editions], and Fedora Council representatives. This is not a technical status dashboard.