Forms for creation/edit of wiki pages (and maybe issues too...)
Description
Some documentation content in wikis would be improved if users were guided/forced to fill in specific sections when they created it.
GitLab already has issue templates. This could be improved so that the template is used to generate a form, and the user creates/modifies the content by filling in the form fields.
Proposal
Currently the issues ui supports markdown and basic templates, so users can create documents with formatting and get some guidance for headers/sections.
If the ui could render the templates as forms, we could be sure that the user-entered content matches our desired structure/schema.
Ideally the templates could be specified in json/yaml, and usable for creation of wiki pages as well as issues.
Links / references
Documentation blurb
Overview
Use cases
In many cases project documentation is stored in wikis.
Some project documentation is best done in a structured way, for example:
-
troubleshooting guides typically have a description of the problem, and a separate description of things to try
-
requirements documents typically have title, description, and links/mappings to other documents, such as tests.
Feature checklist
Make sure these are completed before closing the issue, with a link to the relevant commit.
-
Feature assurance -
Documentation -
Added to features.yml