Add instructions and example of how to create Pull Requests for documentation #627
Open
2 tasks done
Labels
support
Community support
Important notices
Before you add a new report, we ask you kindly to acknowledge the following:
Is your feature request related to a problem? Please describe.
This is not a report of a problem.
A clear and concise description of what the problem is including your motivation for the request,
i.e. "For the purpose of [...] I am missing a solution that will [...]."
The current suggestions in the documentation on how to contribute to the documentation itself is insufficient to get a new contributor started.
Describe the solution you like
I'd like to see the current documentation expanded to the point where someone who is new to github and OPNSense can create a new PR for documentation.
A clear and concise description of what you want to happen.
Expand the documentation and provide a step by step with an example to get from zero to PR.
For context, this does not get anyong going:
Of course we can "just send to OPNSense to include" but wouldn't it be better to submit a PR ourselves?
Additionally the docs of the docs themselves ie. this repository https://github.com/opnsense/docs:
has "Prepare build", "Update API endpoints", "Generate HTML documents" and "Live preview of HTML documents". At no point this explains how to create our new document or changes to existing one, to the point where a PR can be submitted.
Describe alternatives you considered
Submit a word processed document on email or post to forum. Help us be of more help.
Additional context
I and sure others too, would like to contribute to the documentation. It would be good to lower the complexity for non-developers. Some people will be happy to learn a new skill that is closer to IT development ie. using github version control, create some content, create a PR. Win-Win.
The text was updated successfully, but these errors were encountered: