wiki icon indicating copy to clipboard operation
wiki copied to clipboard

Updating menu and many other things

Open bennyvasquez opened this issue 1 year ago • 6 comments

What started as a simple plan to add a few new files to the menu became a much bigger undertaking

  • Finding the different groups of articles that were all listed under "series" was causing us to miss out on both SEO and general usability, so I moved them into the main "Documentation" part of the menu.
  • I moved the articles that Tristan recently contributed to their own folder targeted at Desktop setup
  • I moved the NVIDIA driver documentation to its own folder, to make it easier to find.
  • I smoothed out formatting of the code to make it more consistent between files (for example, adding titles to all the files I touched, adding Intros where there weren't any, adding or removing # where necessary to be consistent between articles, etc.

bennyvasquez avatar Jul 18 '24 01:07 bennyvasquez

This needs another set of eyes from someone who's been VERY active in our documentation. Might be best to wait 'till @sboldyreva is back from vacation, unless @andrewlukoshko feels comfortable giving it a review.

bennyvasquez avatar Jul 18 '24 01:07 bennyvasquez

@bennyvasquez I got so confused with the new structure related to AlmaLinux Tutorials and System Series. The updates tell me that these are two separate sub-sections, but the AlmaLinux Tutorial README looks like nginx, system, nvidia, and desktop should be subsections under AlmaLinux tutorials. Could you please take one more look?

sboldyreva avatar Aug 08 '24 11:08 sboldyreva

@bennyvasquez I get a feeling that all the emojis in headings look a bit off our style. I think we better first define their correct usage before placing them there. As currently some pages containt emojies, some contain them only in some headings but not in every heading. Looks a bit like a mess to me.

Also while looking through the pages I notices the inconsistency in some "Steps/lists", for ex in Desktop Series.We would typically desing these steps as a bullet list, but this time they are headings. Should we unify the format there?

image

sboldyreva avatar Aug 08 '24 11:08 sboldyreva

Sonya and talked through this yesterday and decided we're doing this:

  • [x] Get rid of the numbering system
    • [x] in the names of the articles themselves
    • [x] in the links to the articles
    • [x] in the menu
  • [x] Drop the multiple 9.x versions
    • [x] remove links to NginxSeriesA02R91
  • [x] Emojis in the section titles
    • [x] let's drop them for nwo
  • [x] remove the "this article" lines
  • [x] consolidate the 9.1 and 9.2 nginx guides into a single 9.x guide

I'm working on all of these now!

bennyvasquez avatar Sep 12 '24 19:09 bennyvasquez

@sboldyreva this one's ready for you again!

bennyvasquez avatar Sep 12 '24 20:09 bennyvasquez

@bennyvasquez a few more things! overall it look good for now :)

sboldyreva avatar Sep 19 '24 15:09 sboldyreva