8000 Documentation: Add glossary by activus-d · Pull Request #124 · canonical/ubuntu-server-documentation · GitHub
[go: up one dir, main page]

Skip to content

Conversation

@activus-d
Copy link
Contributor

This pull request solves issue #5 by creating a glossary page for the Ubuntu Server Documentation.

Changes

  1. Created a Glossary Page:
  • Added a new glossary.rst file in the reference directory.
  • Populated the glossary with terms from the .custom_wordlist.txt file, leaving definitions as placeholders (Work in Progress) for future updates.
  1. Tested the functionality by referencing the term ACLs in the /openldap/access-control.md file to ensure it links correctly to the glossary.

  2. Updated the index.rst file to include the glossary in the documentation structure.

  3. Added a warning banner to the glossary page to indicate that it is a work in progress and invite contributions.

Copy link
Collaborator
@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

This is brilliant @activus-d, thank you so much for creating this page. I love that you included a link to the contributing docs as well to invite people to contribute. That's a great touch!

I realise we have a lot of duplicates and other terms that shouldn't be included, but I'll create a separate GH issue to deal with those, and an issue for implementing hover-over cross-referencing.

Thanks again for your work, this is a great improvement, and once the glossary is completed it will be even more so!

@s-makin s-makin merged commit 3157343 into canonical:main Jan 22, 2025
1 check passed
@activus-d
Copy link
Contributor Author

I realise we have a lot of duplicates and other terms that shouldn't be included, but I'll create a separate GH issue to deal with those, and an issue for implementing hover-over cross-referencing.

@s-makin Could you please create a separate issue and assign it to me once it’s ready?

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

0