Expand glossary entries with detailed descriptions letter T#427
Expand glossary entries with detailed descriptions letter T#427s-makin merged 12 commits intocanonical:mainfrom
Conversation
Updated the entries of letter T. I have written all the definitions of letter T
slyon
left a comment
There was a problem hiding this comment.
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
| * A text-based input/output device | ||
| * A terminal session | ||
| * A console connection |
There was a problem hiding this comment.
question: Does this need to be indented?
There was a problem hiding this comment.
I thought it will help scanning the entry but you may be right and it is not necessary. Do we have a style guideline on this?
There was a problem hiding this comment.
This does need to be indented to the same depth as the rest of the definition, otherwise Sphinx won't pick up the bullet points as being part of the definition
| TXT | ||
| Trusted Execution Technology | ||
| *Work in Progress* | ||
| TXT is Intel's hardware-based security technology that creates a trusted execution environment to protect systems from software-based attacks. In other words, TXT was designed to make sure that a computer boots into a trusted and verified state before loading the operating system or applications. |
There was a problem hiding this comment.
question: Should we make a cross-reference to the newer "Intel TDX" technology here?
There was a problem hiding this comment.
Yes! good idea :-)
There was a problem hiding this comment.
The TDX definition PR has now been merged, so it should be possible to add a link to that term here :)
|
Hi @slyon Thank you very much for your comments, and sorry for the delay getting back to you. The last 6 weeks have been crazy. I have signed the CLA. I hope you can see it now. |
Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
s-makin
left a comment
There was a problem hiding this comment.
Generally looks good, but I've spotted a couple of other small issues that we will need to fix before merging :)
Refine definitions for TGS, TGT, tmpfs, TPM, and traceback for clarity and readability.
Clarified the definition of Ticket Granting Ticket (TGT) by separating the explanation into two sentences.
s-makin
left a comment
There was a problem hiding this comment.
Thanks for your patience with our end of year break @MariaBego56 :)
I've taken a second look at this pull request and I think we are close to being able to merge it. To make this a bit easier, I've added suggestions inline that would solve each of @slyon's earlier questions. You should be able to commit each of these directly.
After that, please take a look at the items listed in the spelling check as errors. Apart from tmfs (which I've added a suggestion to correct to tmpfs), the other two seem to be valid terms and not errors. To make the spellchecker ignore them, could you add those terms to the .custom_wordlist.txt file? The automated checks should then pass cleanly and we'll be able to merge :) thanks in advance!
| TXT | ||
| Trusted Execution Technology | ||
| *Work in Progress* | ||
| TXT is Intel's hardware-based security technology that creates a trusted execution environment to protect systems from software-based attacks. In other words, TXT was designed to make sure that a computer boots into a trusted and verified state before loading the operating system or applications. |
There was a problem hiding this comment.
The TDX definition PR has now been merged, so it should be possible to add a link to that term here :)
|
Thank you @s-makin, I will do that 😁 |
Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
Co-authored-by: Lukas Märdian <slyon@ubuntu.com>
Co-authored-by: Sally <sally.makin@canonical.com>
Co-authored-by: Sally <sally.makin@canonical.com>
Co-authored-by: Sally <sally.makin@canonical.com>
s-makin
left a comment
There was a problem hiding this comment.
LGTM, @MariaBego56 - thanks for your patience and for the updates! This all looks great, I've got two nits that are triggering the spellchecker, but I'll fix those up. Happy to merge, and thank you for all your continued hard work on the Server docs :)
Description
Updated the entries of letter T. I have written all the definitions of letter T
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!