mirror of
https://github.com/NixOS/nix.dev.git
synced 2024-10-18 00:06:26 -04:00
What you can do for the documentation survey (#647)
Add instructions for contributing to the documentation survey. --------- Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
This commit is contained in:
parent
0eec48e28c
commit
8954c4d7c1
|
@ -47,6 +47,19 @@ Please also state your learning goals and the paths you have taken so far.
|
|||
|
||||
Sharing your first-hand experience is invaluable to better guide our efforts, and will immediately help improve these guides for yourself and everyone else.
|
||||
|
||||
### You are a beginner and want to get involved in improving documentation
|
||||
|
||||
The documentation team is currently carrying out a documentation survey. As we work through this project, updates are made to this [Documentation Survey](./maintainers/working_groups/learning_journey/documentation-survey.md) markdown page.
|
||||
Its purpose is to provide overview of the types, topics, and volume of existing documentation resources and inform future work.
|
||||
|
||||
We would love for you to get involved.
|
||||
Here is how you can help:
|
||||
|
||||
1. Familiarize yourself with the format described at the top of the Documentation Survey page.
|
||||
2. Contribute by making pull requests. Your change should add details to one individual link (bullet point) following the specified format.
|
||||
3. Ensure consistency with existing entries. Your contributions should align with the style and format of previously added bullet points.
|
||||
4. When dealing with a larger resource like the [Nixpkgs manual](https://nixos.org/manual/nixpkgs), start by creating a pull request with a structured outline. Then fill in the details section-by-section, submitting separate pull requests for each section.
|
||||
|
||||
### You have experience teaching Nix?
|
||||
|
||||
You will probably have observed where learners get stuck most often, and which typical needs and questions they have.
|
||||
|
|
Loading…
Reference in a new issue