-
Notifications
You must be signed in to change notification settings - Fork 108
Complete glossary definitions for letters U to Z #424
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
Conversation
Updated glossary entries with definitions for various terms, replacing 'Work in Progress' placeholders with detailed explanations.
slyon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you very much for filling the gaps!
I left a bunch of inline comments. Also, please make sure to have the Canonical CLA signed (see PR description) – as the corresponding CI check is currently failing.
docs/reference/glossary.md
Outdated
| The web address of a resource on the internet. | ||
|
|
||
| URL is a standardized string that specifies the address of a web resource, such as webpages, image, or file, enabling browsers to locate and retrieve it over the internet. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please avoid unnecessary whitespace at the end of the lines and in empty lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @slyon, thank you very much for your comments and feedback. It is much appreciated. I will be more careful in future.
Thanks again :-)
slyon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you very much for filling the gaps!
I left a bunch of inline comments. Also, please make sure to have the Canonical CLA signed (see PR description) – as the corresponding CI check is currently failing.
docs/reference/glossary.md
Outdated
| UDA | ||
| Unified Data Architecture | ||
| *Work in Progress* | ||
| UDA is a framework or approach for integrating and managing data across an organization in a cohesive, standardized manner. The main idea is that instead of having siloed, fragmented data systems across different departments or applications, UDA provides a unified framework for how data is stored, accessed, processed, governed, and shared across the organization. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The second sentence here seems to be saying more-or-less the same thing as the first one. We could probably rephrase this definition to make it a bit more concise - maybe even in a single sentence. What do you think? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @s-makin!
Yes! I will rewrite that. I think I was trying to understand the concept....
|
Thanks for signing the CLA, the checks are all passing cleanly now :) once the pending suggestions are dealt with, I'll be happy to merge |
accepted the suggestion in line 53 ({term} `SSSD`)
Co-authored-by: Sally <sally.makin@canonical.com>
accepted change Window-based to Windows-based Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
accepted typo correction Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
accepted typo correction Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
accepted corrections. Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
accepted correction of content Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
deleted unnecessary "whitespaces" Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
I have accepted all the suggestions by s-makin and slyon Co-authored-by: Sally <sally.makin@canonical.com> Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
Revised definitions for UDA, URL, and virsh in the glossary.
s-makin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your patience on this @MariaBego56. I've taken a second pass over the changes and found a couple of spelling nits. I've also found some glossary links that don't seem to be rendering as expected. These fall into two groups:
- The link isn't showing because of an empty space after
{term}, so Sphinx doesn't recognize it as a glossary term. - In others, there are
{term}s pointing to glossary entries that don't exist, so they just show up as normal text.
In both cases I've marked all the cases where there's a mismatch between the rendered preview and the source, and I've tried to leave suggestions inline on all those places, but it's possible I might have missed some. I'd advise against trying to add the missing glossary entries in this PR - it's easy to fall into an endless rabbit hole that will take a lot of your time, so I'd suggest instead that we remove the {term} tags from any terms without glossary entries for now. We can fill the gaps as "future work" and add the terms back in later :)
|
Yes @s-makin, let's do that. We can keep building tbe glossary from good entries. We can always improve the entries, obviously. Thank you for your notes and advice. 😁 |
s-makin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your patience @MariaBego56, I've finally been able to look back over this pull request. I've fixed up a number of issues with some terms being marked with {term} that didn't have a corresponding definition. After the terms are defined, we can look at linking them up again in the future :) happy to see this landed, thanks for all your continued work on the Server docs! Your contribution is very welcome
Description
Updated glossary entries with definitions for various terms, replacing 'Work in Progress' placeholders with detailed explanations.
Related Issue
If this pull request addresses an existing issue, please link to it below. Use the
Fixes #<issue-number>syntax toclose the issue automatically when the pull request is merged.
Example:
Contributor License Agreement (CLA)
By contributing to this project, you agree to the terms of
the Canonical Contributor License Agreement (CLA).
If you have not already signed the CLA, please do so here.
Commit Message for Squash Merge
We typically squash commits when merging. You can specify the commit message that should be used in this case if you wish.
Provide the desired commit message below:
[(optional) category] Brief description of changes made, and why
Checklist
Additional Notes (Optional)
Add any extra information or context that reviewers may need to know. This could include testing instructions,
screenshots, or links to related discussions.
Thank you for contributing to the Ubuntu Server documentation!