Expand glossary entries with detailed descriptions letter T #427
Conversation
Updated the entries of letter T. I have written all the definitions of letter T
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.
| * 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
| It protects against: | ||
| * Rootkits | ||
| * Boot-level malware | ||
| * Unauthorized changes to firmware or system software |
There was a problem hiding this comment.
Probably no.... I think it is not about a hierarchy, it is probably more aesthetics and therefore not necessary... what do you think ?
There was a problem hiding this comment.
This does need to be indented, the bullet list belongs to the definition so it needs to be indented to the same level.
| 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 :-)
|
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>
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 :)
docs/reference/glossary.md
Outdated
| Ticket Granting Ticket | ||
| *Work in Progress* | ||
| TGT is a credential issued by Kerberos authentication systems that allows users to request service tickets without re-entering their password. | ||
| It is a central component of Kerberos, the network authentication protocol used in Active Directory ({term} `AD`) and many Unix/Linux environments. |
There was a problem hiding this comment.
This sentence needs to be indented to the same level as the previous line, otherwise Sphinx doesn't know it's part of the definition.
docs/reference/glossary.md
Outdated
| tmpfs | ||
| Temporary Filesystem | ||
| *Work in Progress* | ||
| tmfs is a filesystem that stores all files in virtual memory (RAM) instead of on a physical disk, making it extremely fast but also volatile - data disappears when the system reboots or loses power. |
There was a problem hiding this comment.
| tmfs is a filesystem that stores all files in virtual memory (RAM) instead of on a physical disk, making it extremely fast but also volatile - data disappears when the system reboots or loses power. | |
| tmpfs is a filesystem that stores all files in virtual memory (RAM) instead of on a physical disk, making it fast but also volatile - data disappears when the system reboots or loses power. |
docs/reference/glossary.md
Outdated
| traceback | ||
| *Work in Progress* | ||
| Traceback | ||
| traceback is term used in Python. Traceback is a report of the function call stack printed when an exception occurs, showing the sequence of calls leadiing to the error, including file names, line numbers, and the exception type. It helps developers identify and debug issues by tracing execution backward from the failure point. |
There was a problem hiding this comment.
| traceback is term used in Python. Traceback is a report of the function call stack printed when an exception occurs, showing the sequence of calls leadiing to the error, including file names, line numbers, and the exception type. It helps developers identify and debug issues by tracing execution backward from the failure point. | |
| Traceback is term used in Python. It is a report of the function call stack and is printed when an exception occurs. It shows the sequence of calls leading to the error, including file names, line numbers, and the exception type. It helps developers identify and debug issues by tracing execution backward from the failure point. |
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.
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!