guardicore / monkey

Infection Monkey - An open-source adversary emulation platform
https://www.guardicore.com/infectionmonkey/
GNU General Public License v3.0
6.68k stars 786 forks source link

Fix ordering #4200

Closed mssalvatore closed 4 months ago

mssalvatore commented 4 months ago

What does this PR do?

Navigating our documentation at the present time is painful. This is partly due to violations of Diataxis, but also partly due to the random order in which things appear. Ideally, the top menu would be sorted according to weightes (as it is now) to lead the reader through the documentation in a logical progression. In contrast, the submenus would be sorted by name in order to make specific pages easier to find (this is especially useful for submenus like "reference".

Hugo orders items in the navigation bar first by weight, then by date. Since this isn't a blog, the date is not useful way to sort. That leaves weight, but it is cumbersome to need to maintain weights for tens of pages when what is desired is alphabetical sorting. This PR fixes the ordering issues.

The top menu is sorted according to weights, whereas submenus are sorted according to name

Top level menu

image

Submenu

image

PR Checklist

Testing Checklist

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.07%. Comparing base (a96a461) to head (1a317ae).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #4200 +/- ## ======================================== Coverage 77.07% 77.07% ======================================== Files 442 442 Lines 14133 14133 Branches 18 18 ======================================== Hits 10893 10893 Misses 3240 3240 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.