Skip to content

Commit 15ae50e

Browse files
Merge pull request #243 from OpenVoxProject/feat/guildelines
Update documentation guidelines
2 parents ec719ba + 47d6920 commit 15ae50e

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,18 @@ The site is available at `http://localhost:4000`. Navigation changes require upd
4444

4545
## Writing guidelines
4646

47+
### Naming of OpenVox and Puppet
48+
49+
- `OpenVox` is used when referring to the community implementation of `Puppet` DSL
50+
- `Puppet` is used when describing the underlying DSL or the ecosystem as a whole
51+
52+
Use the following terms for the individual components:
53+
54+
- OpenVox Server
55+
- OpenVoxDB
56+
- OpenFact
57+
- OpenBolt
58+
4759
### Writing and editing pages
4860

4961
- Prefer editing existing pages over creating new ones
@@ -73,3 +85,11 @@ The site is available at `http://localhost:4000`. Navigation changes require upd
7385

7486
- File names and paths: `monospace`
7587
- Commands and code: `monospace`; short commands inline, longer blocks in fenced code blocks with a language identifier (`bash`, `yaml`, `text`, etc.)
88+
- Use `command` language identifier in favor of `shell`
89+
90+
### Linking
91+
92+
- Don't use URI for links pointing to files form this documentation
93+
- Use URI when referring to remote locations
94+
- Use absolute paths when pointing to files from other sections
95+
- Use filename only without path when referring to a file in the same directory

0 commit comments

Comments
 (0)