You canįreely include or link presentations, diagrams, and videos. Include any media types/sources if the content is relevant to readers. The documentation includes all media types Unlikely a user is to encounter a situation. GitLab adds all troubleshooting information to the documentation, no matter how If you think you have found an exception to this rule, contact the Helpful to others and, when properly explained, its benefits outweigh the risks. This kind of content should be included as it could be Risky, but provide proper context through fully detailed Include problem-solving actions that may address rare cases or be considered The documentation includes all information It also informs decisions about the kinds of content we include in ourĭocumentation. This policy prevents information silos, making it easier to find information It evolvesĬontinuously, in keeping with new products and features, and with improvements Information related to GitLab implementation, usage, and troubleshooting. The GitLab documentation is the SSOT for all Recent updates to this guide Documentation is the single source of truth (SSOT).Google Developer Documentation Style Guide.In addition to this page, the following resources can help you craft and contribute to documentation: If you have access to the GitLab Slack workspace, This document defines the standards for GitLab documentation, including grammar, formatting, word use, and more.įor style questions, mention in an issue or merge request. Feature flags Documentation Style Guide.Configuration documentation for source and Omnibus installations.Choose between an ordered or unordered list.Markdown rule MD044/proper-names (capitalization).The documentation includes all media types.The documentation includes all information.Documentation is the single source of truth (SSOT).
0 kommentar(er)
