cc-oci-runtime
cc-oci-runtime copied to clipboard
Create wiki page detailing our documentation rules
We need a page under https://github.com/01org/cc-oci-runtime/wiki that lists details on how to write consistent documentation for the project.
The page should cover such topics as:
- How to reference the name of this project:
- "Intel® Clear Containers" for the first instance in a file.
- "Clear Containers" on any subsequent instances.
- How to reference the repository URL:
- https://github.com/01org/cc-oci-runtime
- How to reference the repository name: "cc-oci-runtime".
- How to reference command names:
- Use a fixed-width font:
-
cc-oci-runtime
-
echo(1)
-
bash(1)
.
-
- Use a fixed-width font:
- How to reference 3rd party product names.
- How to ensure it is clear whether a command, project, repo name or 3rd-party product is being referred to.
- et cetera.
Other things to consider specifying:
- Accepted spellings (for example, "utilize" or "utilise" (or either)).
- Numbers should be written as words if less than or equal to ten.
Oh for a "Strunk and White" github webhook service... :smile: