From a1a7eac73b402a9394753c3e3ea0ddc74ba1867c Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Sat, 23 May 2026 01:18:19 +0200 Subject: [PATCH 1/3] Update documentation guidelines Adding sections for wording and linking. Expanding fenced code blocks fixes: #235 Signed-off-by: Martin Alfke --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a89276b6..23f99fd53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,18 @@ The site is available at `http://localhost:4000`. Navigation changes require upd ## Writing guidelines +### Naming of OpenVox and Puppet + +- `OpenVox` is used referring to the community implementation of `Puppet` DSL +- `Puppet` is used when describing the underlying DSL + +Use the following terms for the individual components: + +- OpenVox Server +- OpenVoxDB +- OpenFact +- OpenBolt + ### Writing and editing pages - Prefer editing existing pages over creating new ones @@ -73,3 +85,11 @@ The site is available at `http://localhost:4000`. Navigation changes require upd - File names and paths: `monospace` - Commands and code: `monospace`; short commands inline, longer blocks in fenced code blocks with a language identifier (`bash`, `yaml`, `text`, etc.) +- Use `command` language identifier in favor of `shell` + +### Linking + +- Don't use URI for links pointing to files form this documentation +- Use URI when referring to remote locations +- Use absolute paths when pointing to files from other sections +- Use filename only without path when referring to a file in the same directory From b7997ee0ebceed7b82b8be7b655a00153dde2292 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Sat, 23 May 2026 01:20:37 +0200 Subject: [PATCH 2/3] Fix wording for OpenVox Signed-off-by: Martin Alfke --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23f99fd53..90785cdc5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ The site is available at `http://localhost:4000`. Navigation changes require upd ### Naming of OpenVox and Puppet -- `OpenVox` is used referring to the community implementation of `Puppet` DSL +- `OpenVox` is used when referring to the community implementation of `Puppet` DSL - `Puppet` is used when describing the underlying DSL Use the following terms for the individual components: From 47d69201b47a5ad712fbdf21c11344bf8dc6931f Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Sat, 23 May 2026 01:37:05 +0200 Subject: [PATCH 3/3] Update CONTRIBUTING.md Co-authored-by: Ben Ford Signed-off-by: Martin Alfke --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90785cdc5..6d727858a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,7 +47,7 @@ The site is available at `http://localhost:4000`. Navigation changes require upd ### Naming of OpenVox and Puppet - `OpenVox` is used when referring to the community implementation of `Puppet` DSL -- `Puppet` is used when describing the underlying DSL +- `Puppet` is used when describing the underlying DSL or the ecosystem as a whole Use the following terms for the individual components: