-
Notifications
You must be signed in to change notification settings - Fork 17
Add some new terms to the glossary #63
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
base: main
Are you sure you want to change the base?
Conversation
There were a bunch of terms that showed up in the word list that weren't defined. Now they are. Plus a couple more.
|
Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-63 |
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.
Code Review
This pull request significantly expands the glossary with many new terms, which is a valuable addition to the documentation. The definitions are generally well-written and informative.
My review focuses on ensuring accuracy, consistency in formatting (especially for internal links), and correctness of the information provided. I've identified a few typos and areas where links could be improved for clarity and correctness.
Summary of Findings
- Typographical Errors: Several entries contain minor typos (e.g., 'issues' instead of 'issued' for CA, 'are using' and 'cetificates' for CSR, 'MOCRE' instead of 'MCORE' for MCORE, 'proucts' instead of 'products' for PID). These have been flagged with suggestions.
- Link Consistency (Trailing Slashes): Multiple new and modified internal links use a trailing slash (e.g.,
../Path/To/File/), which is inconsistent with the more common pattern in this file of omitting the trailing slash for direct links to.mdfiles (e.g.,../Path/To/File). This was noted for lines 29 (commissioning), 36 (DCL), 48 (IM), 58 (NOC), and 89 (VID). A general recommendation is to standardize these. - Link Relevance and Accuracy: The link for NOC (Node Operational Certificate) was updated but points to the Attestation page while its link text is 'Commissioning'. NOCs are more directly covered in the Commissioning process. A correction has been suggested.
- HTTP Link: The link for OpenThread uses HTTP. It should be updated to HTTPS for security best practices.
- Minor Formatting (Not Commented): Some new entries have trailing whitespace at the end of the definition cell (e.g., CI, CLI, CRL, FRP). While Markdown typically handles this, removing it would be cleaner. Per review settings, these low-severity issues were not commented on directly.
Merge Readiness
The pull request adds a lot of useful information to the glossary. However, due to the identified high-severity issues (incorrect term in MCORE definition, misleading link for NOC) and several medium-severity issues (typos, link inconsistencies), I recommend addressing these points before merging. This will ensure the glossary is accurate, professional, and easy to navigate. I am not authorized to approve pull requests, so please ensure further review and approval as per your team's process once changes are made.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-63 |
|
Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-63 |
problems addressed. Gemini man...you need a bit of chill. These were typos.
|
Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-63 |
1 similar comment
|
Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-63 |
|
Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-63 |
|
Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-63 |
jcps07
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.
LGTM, @cecille can you confirm this is ready for merge?
Vyrastas
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.
Copyedit nits
| | BLE | Bluetooth Low Energy. BLE is used in many Matter devices for commissioning. | ||
| | BOM | Bill of Materials. This term is generally used to refer to the total cost to manufacture one unit of a product. |
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.
I'm not sure if it matters (since the rows are still rendered), but some lines are missing the | at the end of the line. For consistency might be good to add them
| | BLE | Bluetooth Low Energy. BLE is used in many Matter devices for commissioning. | ||
| | BOM | Bill of Materials. This term is generally used to refer to the total cost to manufacture one unit of a product. | ||
| | BR | Border Router. This type of router connects two communication protocols. Matter uses both Thread and Wi-Fi as operational transports, and therefore a Thread border router (TBR) is required to route packets between the Thread and Wi-Fi networks.| | ||
| | CA | Certificate Authority. These entities store, sign and issue digital certificates. In Matter, the Device attestation certificate chain is backed by a Product Attestation Authority certificate that is issues by a manufacturer CA or the CA of a certificate provider (also called a Public Key Infrastructure (PKI) provider). The Node Operational Certificate (NOC) chains are backed by a Trusted Root Certificate that chains to a CA managed by the Fabric administrator. | |
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.
| | CA | Certificate Authority. These entities store, sign and issue digital certificates. In Matter, the Device attestation certificate chain is backed by a Product Attestation Authority certificate that is issues by a manufacturer CA or the CA of a certificate provider (also called a Public Key Infrastructure (PKI) provider). The Node Operational Certificate (NOC) chains are backed by a Trusted Root Certificate that chains to a CA managed by the Fabric administrator. | | |
| | CA | Certificate Authority. These entities store, sign, and issue digital certificates. In Matter, the Device attestation certificate chain is backed by a Product Attestation Authority certificate that is issued by a manufacturer CA or the CA of a certificate provider (also called a Public Key Infrastructure (PKI) provider). The Node Operational Certificate (NOC) chains are backed by a Trusted Root Certificate that chains to a CA managed by the Fabric administrator. | |
| | CHIP | Matter used to be called Project CHIP (Connected Home over IP) before it got its current name. Much of the SDK still uses that prefix. | | ||
| | CI | Continuous Integration. This is normally used to refer to the tests performed before pull requests can be merged into any of the Matter-owned repositories. | | ||
| | CLI | Command line interface. | | ||
| | commissioning | This is the process by which Matter devices are attested, issued operational certificates and credentials for the operational network. More information about the commissioning process can be found in the [Commissioning guide](../howitworks/commissioning). | |
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.
| | commissioning | This is the process by which Matter devices are attested, issued operational certificates and credentials for the operational network. More information about the commissioning process can be found in the [Commissioning guide](../howitworks/commissioning). | | |
| | commissioning | This is the process by which Matter devices are attested and issued operational certificates and credentials for the operational network. More information about the commissioning process can be found in the [Commissioning guide](../howitworks/commissioning). | |
| | CRL | Certificate revocation list. This is a list of certificates that were previously issued by a CA, but that have since been revoked. | | ||
| | CSA | Connectivity Standards Alliance - the member-driven organization that manages the Matter standard | | ||
| | CSG | Certification Sub Group [CSG](https://groups.csa-iot.org/wg/matter-csg/workgroup) | | ||
| | CSR | Certificate signing request. CSRs are using during the commissioning process to issue operational certificates for a node. For more information on the operational certificate signing process, please see the [Commissioning](../HowItWorks/Commisioning) section of the handbook. |
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.
| | CSR | Certificate signing request. CSRs are using during the commissioning process to issue operational certificates for a node. For more information on the operational certificate signing process, please see the [Commissioning](../HowItWorks/Commisioning) section of the handbook. | |
| | CSR | Certificate signing request. CSRs are used during the commissioning process to issue operational certificates for a node. For more information on the operational certificate signing process, please see the [Commissioning](../HowItWorks/Commisioning) section of the handbook. |
| | CA | Certificate Authority. These entities store, sign and issue digital certificates. In Matter, the Device attestation certificate chain is backed by a Product Attestation Authority certificate that is issues by a manufacturer CA or the CA of a certificate provider (also called a Public Key Infrastructure (PKI) provider). The Node Operational Certificate (NOC) chains are backed by a Trusted Root Certificate that chains to a CA managed by the Fabric administrator. | | ||
| | CASE | Certificate Authenticated Session Establishment. This is the session establishment mechanism used during normal Matter operations | | ||
| | Causeway | Site used to store documents and calendars and track group memberships etc. [https://groups.csa-iot.org/](https://groups.csa-iot.org/) | | ||
| | CCB | Change Control Board. In the Alliance, CCB is also used as a short-form to refer to issues raised in the CCB system. CCB issues may be raised by members to report issues in either the specification or the test plan. These are most commonly raised for test issues found at certification. The certification section has more information about the [CCB process](../Certification/certifying-a-product/self-pre-test#fixing-bugs). | |
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.
| | CCB | Change Control Board. In the Alliance, CCB is also used as a short-form to refer to issues raised in the CCB system. CCB issues may be raised by members to report issues in either the specification or the test plan. These are most commonly raised for test issues found at certification. The certification section has more information about the [CCB process](../Certification/certifying-a-product/self-pre-test#fixing-bugs). | | |
| | CCB | Change Control Board. In the Alliance, CCB is also used to refer to issues raised in the CCB system. CCB issues may be raised by members to report issues in either the specification or the test plan. These are most commonly raised for test issues found at certification. The certification section has more information about the [CCB process](../Certification/certifying-a-product/self-pre-test#fixing-bugs). | |
| | NOC | Node operational certificate. See [Operational Credentials](https://handbook.buildwithmatter.com/howitworks/fabric/) | | ||
| | NOCSR | Node Operational Certificate Signing Request. See [Attestation](https://handbook.buildwithmatter.com/howitworks/attestation/) | | ||
| | NOKP | Node Operational Key Pair. This is the key pair generated on the device as part of the operational certificate signing process. See [Commissioning](../howitworks/commisioning)| | ||
| | OpenThread | [OpenThread](https://openthread.io/) is an implementation of the thread protocol.| |
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.
| | OpenThread | [OpenThread](https://openthread.io/) is an implementation of the thread protocol.| | |
| | OpenThread | [OpenThread](https://openthread.io/) is an implementation of the Thread protocol.| |
| | DMTT | Data Model Tiger Team. | | ||
| | DNS-SD | Domain name service (DNS) service discovery. This is the mechanism used to locate Matter devices on the IP network | | ||
| | DRLC | Demand Response Load Control | | ||
| | EP | This is a shorthand notation used in some documents to refer to an endpoint on a Matter node. The [Data model](../HowItWorks/DataModel) section has information on Matter nodes and endpoints. |
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.
| | EP | This is a shorthand notation used in some documents to refer to an endpoint on a Matter node. The [Data model](../HowItWorks/DataModel) section has information on Matter nodes and endpoints. | |
| | EP | Used in some documents to refer to an endpoint on a Matter node. The [Data model](../HowItWorks/DataModel) section has information on Matter nodes and endpoints. |
Shorthand notation is more like using symbols and such
| | DAC | Device Attestation Certificates. See [Attestation](https://handbook.buildwithmatter.com/howitworks/attestation/) | | ||
| | DCL | Distributed compliance ledger. This system is used to distribute additional information about Matter products. Please see the [DCL guide](../Guides/DistributedComplianceLedger/) for more information.| | ||
| | DM | Data Model. The data model describes the organization of data within a cluster. DM is sometimes also used to refer to the DMTT. | | ||
| | DMTT | Data Model Tiger Team. | |
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.
Tiger Team capitalized while other instances are lowercase
| | SVE | Specification Validation Event - this follows the test events and acts as the final check on the certification package for a release. | | ||
| | SWTT | [Software development tiger team](https://groups.csa-iot.org/wg/matter-tsg-swd/workgroup). This is the group of people working on the SDK. | | ||
| | TCOC | Testing and Certification Oversight Committee. This is an Alliance board-level committee that is responsible for overseeing the certification programs of all the working groups.| | ||
| | TCP | Transmission Control Protocol. TCP is a reliable, connection-oriented network transmission protocol. TCP is a recent addition to the Matter specification, used primarily by the camera stack to transmit large messages that do not fit into a MTU.| |
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.
| | TCP | Transmission Control Protocol. TCP is a reliable, connection-oriented network transmission protocol. TCP is a recent addition to the Matter specification, used primarily by the camera stack to transmit large messages that do not fit into a MTU.| | |
| | TCP | Transmission Control Protocol. TCP is a reliable, connection-oriented network transmission protocol. TCP is a recent addition to the Matter specification, used primarily by the camera stack to transmit large messages that do not fit into an MTU.| |
| | SWTT | [Software development tiger team](https://groups.csa-iot.org/wg/matter-tsg-swd/workgroup). This is the group of people working on the SDK. | | ||
| | TCOC | Testing and Certification Oversight Committee. This is an Alliance board-level committee that is responsible for overseeing the certification programs of all the working groups.| | ||
| | TCP | Transmission Control Protocol. TCP is a reliable, connection-oriented network transmission protocol. TCP is a recent addition to the Matter specification, used primarily by the camera stack to transmit large messages that do not fit into a MTU.| | ||
| | TCR | Technical Change Request. A technical change request is used for small changes to existing specification element. These are intended to be a lightweight process for small improvements.| |
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.
| | TCR | Technical Change Request. A technical change request is used for small changes to existing specification element. These are intended to be a lightweight process for small improvements.| | |
| | TCR | Technical Change Request. A technical change request is used for small changes to existing specification elements. These are intended to be a lightweight process for small improvements.| |
There were a bunch of terms that showed up in the word list that weren't defined. Now they are. Plus a couple more.