Home Explore Blog CI



docker

3rd chunk of `content/contribute/guides.md`
25c1e69ebb5e49dc60e41c73a5d2dc1840e572fd622fd77200000001000009a1
   - Guide the user on how to execute or deploy the solution.
   - Discuss any verification steps to ensure success.
6. **Conclusion**
   - Recap what was achieved.
   - Suggest further reading or advanced topics.

## Example code

If you create an example repository with source code to accompany your guide,
we strongly encourage you to publish that repository under the
[dockersamples](https://github.com/dockersamples) organization on GitHub.
Publishing your source code under this organization, rather than your personal
account, ensures that the source code remains accessible to the maintainers of
the documentation site after publishing. In the event of a bug or an issue in
the guide, the documentation team can more easily update the guide and its
corresponding example repository.

Hosting the examples in the official samples namespace also helps secure trust
with users who are reading the guide.

### Publish a repository under `dockersamples`

To publish your repository under the `dockersamples` organization, use the
[dockersamples template](https://github.com/dockersamples/sample-app-template)
to initiate a sample repository under your personal namespace. When you've
finished drafting your content and opened your pull request for the
documentation, we can transfer the repository to the dockersamples
organization.

## Writing style

Use [sentence case](/contribute/style/formatting.md#capitalization) for all
headings and titles. This means only the first word and proper nouns are
capitalized.

### Voice and tone

- **Clarity and conciseness**: Use simple language and short sentences to convey information effectively.
- **Active voice**: Write in the active voice to engage the reader (e.g., "Run the command" instead of "The command should be run").
- **Consistency**: Maintain a consistent tone and terminology throughout the guide.

For detailed guidelines, refer to our [voice and tone documentation](/contribute/style/voice-tone.md).

### Formatting conventions

- **Headings**: Use H2 for main sections and H3 for subsections, following sentence case.
- **Code examples**: Provide complete, working code snippets with syntax highlighting.
- **Lists and steps**: Use numbered lists for sequential steps and bullet points for non-sequential information.
- **Emphasis**: Use bold for UI elements (e.g., **Button**), and italics for emphasis.
- **Links**: Use descriptive link text (e.g., [Install Docker](/get-started/get-docker.md)).

Title: Example Code, Publishing Repositories, and Writing Style Guidelines
Summary
This section provides guidance on including example code in guides, recommending the use of the `dockersamples` GitHub organization for hosting repositories to ensure maintainability. It also outlines writing style guidelines, emphasizing clarity, active voice, and consistency. Formatting conventions for headings, code examples, lists, emphasis, and links are also detailed.