Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating menu and many other things #461

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

Conversation

bennyvasquez
Copy link
Member

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 bennyvasquez requested a review from codyro July 18, 2024 01:58
@bennyvasquez
Copy link
Member Author

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.

docs/series/desktop/desktopseries01.md Outdated Show resolved Hide resolved
docs/series/desktop/desktopseries02.md Outdated Show resolved Hide resolved
docs/series/desktop/desktopseries03.md Outdated Show resolved Hide resolved
docs/series/desktop/desktopseries04.md Outdated Show resolved Hide resolved
docs/series/desktop/desktopseries05.md Outdated Show resolved Hide resolved
docs/series/nvidia/nvidiaseries9x.md Outdated Show resolved Hide resolved
docs/series/nvidia/nvidiaseries9x.md Show resolved Hide resolved
docs/series/system/SystemSeriesA02.md Outdated Show resolved Hide resolved
docs/series/system/SystemSeriesA01.md Outdated Show resolved Hide resolved
docs/series/system/SystemSeriesA04.md Outdated Show resolved Hide resolved
@sboldyreva
Copy link
Contributor

@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
Copy link
Contributor

@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

@bennyvasquez
Copy link
Member Author

bennyvasquez commented Sep 12, 2024

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

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

I'm working on all of these now!

@bennyvasquez
Copy link
Member Author

@sboldyreva this one's ready for you again!

docs/series/README.md Outdated Show resolved Hide resolved
docs/series/README.md Outdated Show resolved Hide resolved
Comment on lines +5 to +7
# AlmaLinux Tutorials

Welcome to our tutorial series on AlmaLinux! In this series, we provide comprehensive guides and tutorials to help you learn and master various aspects of AlmaLinux. Whether you are interested in Nginx or system-related topics, we've got you covered.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure I understand the designed structure here. This README lists all possible tutorials/series/guides even if they are not in AlmaLinux Tutorials section
image
A few questions here in this case:

  • There's a category of tutorials that are listed here - "System series" and only they are in "AlmaLinux Tutorials - but in the side-menu they are not under System series
  • I can see LAMP server tutorial in the side-menu but it's not listed here?

- [A05](system/SystemSeriesA05.md) ❯ Multimedia Codecs Installation Guide
- [Understanding Application Streams](system/SystemSeriesA01) ❯
- [Firewalld: A Beginner's Guide](system/SystemSeriesA02) ❯
- [Snapd Installation Guide for AlmaLinux](system/SystemSeriesA04) ❯
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- [Deploy a LAMP server](/series/LAMP-server)

- [A05](system/SystemSeriesA05.md) ❯ Multimedia Codecs Installation Guide
- [Understanding Application Streams](system/SystemSeriesA01) ❯
- [Firewalld: A Beginner's Guide](system/SystemSeriesA02) ❯
- [Snapd Installation Guide for AlmaLinux](system/SystemSeriesA04) ❯

Dive into our Howto series and unlock the full potential of AlmaLinux. Happy hacking! 🐧💻🚀
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we move this line to the end of the page right before trademark notice?

docs/series/nginx/NginxSeriesA02R92.md Outdated Show resolved Hide resolved
@@ -590,19 +102,19 @@ nginx version: nginx/1.22.1

#### Example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a Variant III heading above that has an emoji left

Comment on lines +12 to +18
- Option I: Precompiled/Binary Driver - using precompiled drivers is recommended.
- Option II: Compile Driver Source - requires switching to an ELRepo kernel.
- Option III: NVIDIA .run Driver Installation Guide - requires manual installation of dependencies and downloading the driver manually from Nvidia website

- NVIDIA on AlmaLinux Overview [NVIDIA Drivers Guide for AlmaLinux](/series/nvidia/)
- NVIDIA Driver Installation Guide ❯ [Installation on 8.x](/series/nvidia/nvidiaseries8x)
- NVIDIA Driver Installation Guide ❯ [Installation on 9.x](/series/nvidia/nvidiaseries9x)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this list looks a bit confusing for me
image

can we split it like something like:

These guides provide instructions:
- NVIDIA on AlmaLinux Overview [NVIDIA Drivers Guide for AlmaLinux](/series/nvidia/)
- NVIDIA Driver Installation Guide ❯ [Installation on 8.x](/series/nvidia/nvidiaseries8x)
- NVIDIA Driver Installation Guide ❯ [Installation on 9.x](/series/nvidia/nvidiaseries9x)

Each guide provides steps to install NVIDIA's driver in 3 different ways:
- Option I: Precompiled/Binary Driver - using precompiled drivers is recommended.
- Option II: Compile Driver Source - requires switching to an ELRepo kernel.
- Option III: NVIDIA .run Driver Installation Guide - requires manual installation of dependencies and downloading the driver manually from Nvidia website

docs/series/nvidia/nvidiaseries8x.md Outdated Show resolved Hide resolved
docs/series/nvidia/nvidiaseries8x.md Outdated Show resolved Hide resolved
@sboldyreva
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants