![]() The GitLab documentation is not localized, but we follow guidelines that Maintaining a knowledge base separate from the documentation wouldīe against the documentation-first methodology, because the content would overlap with Review theĭocumentation guidelines before you begin your first documentation MR. The team is happy to review and improve upon your content. Otherwise, forge ahead with your best effort. ![]() They’re available on Slack in #docs or in GitLab by If you have questions when considering, authoring, or editing documentation, ask The documentation helps others efficiently accomplish tasks and solve problems. The more we reflexively add information to the documentation, the more Of GitLab should not be written directly in a forum or other messaging system,īut added to a documentation MR and then referenced, as described above. New information that would be useful toward the future usage or troubleshooting You can then share the MR to communicate this information. Should be to create a merge request (MR) to add this information to theĭocumentation. When you encounter new information not available in GitLab documentation (forĮxample, when working on a support case or testing a feature), your first step.If the answer to a question exists in documentation, share the link to theĭocumentation instead of rephrasing the information. ![]() Remains a complete and trusted resource, and makes communicating about the use We employ a documentation-first methodology. Of truth and explain why it is important. Rather than repeating information from another topic, link to the single source Information into a format that is geared toward helping others, rather thanĭocumenting how a feature was implemented. Topic types (tasks specifically) help put Content is often written from the contributor’s point of view.Topic types create repeatable patterns that make our content easier Our docs are comprehensive and include a large amount of Move in this direction, so we can address these issues: In the software industry, it is a best practice to organize documentation inĪt GitLab, we have not traditionally used topic types. Relevant information in your own words or link out to the other source. Typically it is better to either rephrase ![]()
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |