Skip to content

Commit 3050e21

Browse files
breedx-splkpjanottipellared
authored
Clarify that deployments should live in each repo in a subdir of deployments (#345)
* clarify that deployments should live in each repo in a subdir of `deployments` * lint * lint * lint * Update specification/repository.md Co-authored-by: Paulo Janotti <[email protected]> * Update specification/repository.md Co-authored-by: Paulo Janotti <[email protected]> * Update specification/repository.md * Update specification/repository.md * Update specification/repository.md Co-authored-by: Robert Pająk <[email protected]> --------- Co-authored-by: Paulo Janotti <[email protected]> Co-authored-by: Robert Pająk <[email protected]>
1 parent feb3f67 commit 3050e21

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

specification/repository.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,22 @@ to the repo.
191191
- SHOULD define maximum supported version of each auto-instrumentation framework
192192
- MAY host the documentation in the [Observability Cloud documentation repository](https://github.com/splunk/public-o11y-docs)
193193

194+
## Deployments
195+
196+
For this section, "deployments" refers to software tools, utilities, and
197+
configuration for packaging, distributing, and installing GDI software.
198+
Typically, these are 3rd-party frameworks like Ansible, Puppet, Chef,
199+
CloudFoundry, etc.
200+
The `splunk-otel-collector`
201+
[deployments](https://github.com/signalfx/splunk-otel-collector/tree/main/deployments)
202+
are a good example of this.
203+
204+
- Repository MAY include one or more deployments.
205+
- Each deployment MUST be in its own subdirectory under
206+
the `deployments` folder at the repository root.
207+
- An historical exemption is provided for `splunk-otel-collector-chart`, which
208+
MAY live in a separate repository.
209+
194210
## Real User Monitoring Libraries
195211

196212
- MUST document all configuration parameters that are relevant

0 commit comments

Comments
 (0)