Skip to content
This repository was archived by the owner on Mar 28, 2018. It is now read-only.
This repository was archived by the owner on Mar 28, 2018. It is now read-only.

Create wiki page detailing our documentation rules #788

Open
@jodh-intel

Description

@jodh-intel

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:
  • 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).
  • 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.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions