There’s a free trial of Splunk Observability Cloud you can use to get started. If you’re entering the technical writing profession, adding docs to our repository is a fantastic way of adding new samples to your documentation portfolio. You can also submit deeper changes, such as conceptual explanations, diagrams, and even entire new topics that can benefit all users. Fix formatting glitches, wrong capitalization, duplicated words, and more.Update outdated screenshots and animations to reflect the current UI.Correct incorrect information, like a wrong default value or command.Update broken links that point to Splunk documentation or external sites.Add new code snippets and examples for our instrumentation and agents.In only a few minutes of your time, you can: What are the types of things you can contribute to the Splunk Observability Cloud documentation? There are many! Docs require constant care and we always strive to improve the relevance and usefulness of our content. By giving you, the user, the power to edit the docs, we’re increasing the speed of improving the docs and creating a more effective feedback loop.Īll things small and beautiful.and editable Many of them are quick corrections that our feedback submitters could solve immediately if they had direct access to the source files. Every month we get dozens of feedback tickets from Splunkers and customers. Opening the docs to community contributions also improves our efficiency and responsiveness. Making the jump to publicly available source is a natural progression in our journey to empower users, and the first step in making more Splunk documentation content available for community contribution. Prior to now, the docs were in an internal repository that let any Splunk employee review and edit the docs. Open source contributions and docs-as-code principles are at the core of how the Observability docs team works. Why we’re opening the docs for community contributions That's why we're giving you a new way to contribute directly. You have proven that you’re invested in our documentation and want to work with us to make it great. The customers, partners, and Splunkers who comprise our community (that’s you!) are passionate about sharing their knowledge and experience to help everyone successfully implement and use Splunk software. Together with the existing Feedback feature, the Edit this page link is the simplest and most direct way to ensure that we’re providing the highest quality, most up-to-date product documentation. The Splunk documentation team believes that the product is docs, and that great docs are key to the success of great software and the success of its users. All you have to do is select the Edit this page link on any page of the Observability Cloud documentation. By opening the Observability docs for community contribution, we’ve made it easier to ensure we’re providing the highest quality, most up-to-date content for you to use every day. By Fabrizio Ferri Benedetti, Robin Pille, and Christopher GalesĪs part of our long-term documentation strategy, now anyone, from Splunkers to Splunk users, can improve the Splunk Observability Cloud documentation by adding examples, documenting new settings, or fixing issues.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |