Skip to content

Commit 5c0b213

Browse files
committed
add reverse domain name recommendation for private / experimental namespaces
1 parent 5b8c98f commit 5c0b213

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/reference/code/namespaces.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,14 @@ use only.
115115

116116
The SSVC project does not manage namespaces with the `x_` prefix, so
117117
collisions may occur across organizations who develop their own private SSVC
118-
namespaces.
118+
namespaces.
119+
120+
!!! warning "Reverse domain name notation recommended"
121+
122+
We strongly recommend using reverse domain name notation for private namespaces to
123+
avoid conflicts with other users' private namespaces. This helps to ensure
124+
that your private namespaces are unique and easily identifiable.
125+
E.g., `x_org.cert-experimental` for an experimental namespace within the CERT organization.
119126

120127
!!! example "OT Monitoring Service (OTMS) Private Namespace"
121128

@@ -233,6 +240,8 @@ segment of the extension.
233240
To avoid conflicts with other users' extensions, we recommend using reverse
234241
domain name notation for your extensions. This helps to ensure that your
235242
extensions are unique and easily identifiable.
243+
For example, if your organization is `example.com`, you might use an extension
244+
like `ssvc//com.example/extension`.
236245

237246
!!! example "Reverse Domain Name Notation"
238247

0 commit comments

Comments
 (0)