The documentation team has made a few changes to the docs GitHub repo, that makes it a little easier for Pantheors and external contributors to create a docs issue.
We have disabled the option to open a blank issue, have created issue templates, and encourage docs contributors to choose from the templates provided. Now, when you click New Issue under the Issues tab, you can choose from creating an issue that requests new content, creating an issue to fix existing content, or selecting the option to just chat about docs issues.
The new templates allow us to streamline issue triaging and better identify how we can improve the Pantheon docs site. In the templates, specifications for
projects are automatically applied, and the structure helps to pinpoint how the change will impact Pantheon users.
To create the templates, we created and added content to the
ISSUES_TEMPLATE folder . The template files are written in Markdown with a YAML formatter that specifies configurations. We customized the issue template chooser, by adding a
config.yml file to the
.github/ISSUE_TEMPLATE folder. If you are interested in viewing the code for our templates, please see our repo. You can also learn more about creating issue templates in GitHub via the UI, by reading this doc.
You can also always Report an issue or Edit a page directly from the Pantheon docs site pages.
Contributions to improve Pantheon documentation are welcome, encouraged, and greatly appreciated. We want the best documentation possible for our community! Every little bit helps and we recognize all of our amazing contributors.
For more information about contributing to Pantheon documentation, please see our contributing docs.