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.

Sign up for GitHub

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

Jump to bottom

docs: adjust language on releases #778

Merged
merged 5 commits into from
Feb 10, 2025
Merged

docs: adjust language on releases #778

merged 5 commits into from
Feb 10, 2025

Conversation

edibotopic
Copy link
Contributor

This PR makes small changes to authd's howto/install guide to improve clarity and consistency:

  • Be more consistent in release language: The 'stable' release of authd is referred to elsewhere, including the homepage, the README and the PPA page. To be consistent, we should not refer to it as a 'testing' release in the how-to install guide.
  • Try to clearly highlight Desktop and Server offering: Instead of giving the install commands for Desktop, and then saying some of the packages in that command aren't needed for Server, the specific commands for both cases are now provided in a tabbed interface. The user can choose the relevant one and copy the appropriate command. That authd can be installed on both systems is also highlighted at the start of the page.

Other minor changes were made to formatting, language and the documentation config file.

UDENG-5903

@edibotopic
refer to stable PPA rather than testing PPA
0e3ea6e 
The term "testing PPA" makes it sound less stable than it is.

In addition, anyone who clicks the link will see "stable PPA".

We also refer to "stable" release in the README, as well as the docs
themselves.

So, we're just being consistent.
@edibotopic
highlight and differentiate Ubuntu systems more clearly
dff44cb 
Originally, only the installation command for Desktop was shown, with a
parenthetical note about not needing certain packages if using Server.
This is now replaced with a tabbed interface, which allows the user to
select the appropriate option and copy the appropriate command for their
system.

In addition, I have tried to make it more clear/obvious where possible
that Desktop and Server are both supported.
@edibotopic
fixups
9dbcd8a 
- added an Install authd sub-section to improve page structure
- various minor changes to language and formatting
@edibotopic
add support for colon fences in markdown syntax
e7ce3cc 
This allows colons as well as backticks to be used in block syntax.

This is necessary for the advanced uses of tabs that will be in these
docs; in addition, it can have readability and rendering advantages for
the raw markdown.
@edibotopic edibotopic marked this pull request as ready for review February 6, 2025 14:41
@edibotopic edibotopic requested a review from a team as a code owner February 6, 2025 14:41
@edibotopic
add note about release to official archive
addd688 
authd is ready to use but not yet available in the official archive.
This adds a clarifying note with a planned LTS release.
@edibotopic edibotopic merged commit d5a360d into main Feb 10, 2025
14 of 16 checks passed
@edibotopic edibotopic deleted the adjust-language-on-releases branch February 10, 2025 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@didrocks didrocks didrocks approved these changes

@adombeck adombeck adombeck approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@edibotopic @didrocks @adombeck