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

docs: homepage refresh #1207

Merged
merged 11 commits into from
Feb 20, 2025
Merged

docs: homepage refresh #1207

merged 11 commits into from
Feb 20, 2025

Conversation

edibotopic
Copy link
Contributor

@edibotopic edibotopic commented Feb 19, 2025

Various changes to improve the user experience when finding and visiting the docs for the first time:

  • Homepage: decreased repetition of content; made less Desktop-specific; improved flow and organisation; linked to specific content from Diataxis cards; converted grid items to cards for improved padding between items
  • Made page titles less generic: some pages were made more discoverable/searchable by giving them more descriptive titles
  • Fixed title: title(s) at top of the documentation should refer to the name used to identify the feature -- ADSys -- rather than its role or function, which is already specified in the main text
  • Edit button: added an edit button at the top of the page to make it more obvious to users wishing to make minor contributions
  • Misc: some fixes to links

UDENG-6060

the feature is known as "ADSys".
it's functionality as the Active Directory Group Policy client can be
expanded in the main text.
this improves the padding between elements in this section
the graphical install method applies to Desktop clients.

the more explicit title will help people search for this guide and
distinguish it from the other guide.
originally, this read as if both methods would be described in this
particular guide.
the original title could just as well apply to Windows clients.

this makes it more discoverable for those interested in Ubuntu.
we don't want to just set up an AD server, we want to set it up for
Ubuntu.
"set up ADSys" is fine, we don't need the dash.
this wasn't caught by the spellchecker
* decreases repetition of similar phrases
* makes content less Desktop-specific
* general improvements in organisation and flow of writing
* emphasises benefit of familiar tooling for Windows-based sys admins
* surfaces key pages in Diataxis grade at bottom of page
adds edit button to top of each page.
easier for contributors to see compared to text at the bottom.
@edibotopic edibotopic marked this pull request as ready for review February 19, 2025 16:24
@edibotopic edibotopic requested a review from a team as a code owner February 19, 2025 16:24
Copy link
Member

@denisonbarbosa denisonbarbosa left a comment

Choose a reason for hiding this comment

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

LGTM!

@edibotopic edibotopic merged commit f9ab6d8 into main Feb 20, 2025
4 of 5 checks passed
@edibotopic edibotopic deleted the docs-homepage-refresh branch February 20, 2025 14:07
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