|
|
| (One intermediate revision by the same user not shown) |
| Line 21: |
Line 21: |
|
| |
|
| == Contributing to the Official NixOS Wiki == | | == Contributing to the Official NixOS Wiki == |
| Contributing to the official NixOS Wiki is an invaluable way to improve documentation, share knowledge, and support users in navigating the NixOS ecosystem. This guide provides clear steps to help you begin contributing effectively to the NixOS Wiki.
| |
|
| |
|
| ==== 2.1 Getting started ==== | | === Contributing to the content === |
| Before you start contributing, familiarize yourself with the structure and purpose of the NixOS Wiki:
| |
|
| |
|
| * '''Explore the wiki:''' Visit this Wiki's main categories to understand its organization and the types of content it hosts. The wiki covers installation guides, configuration tips, package management, and more. | | * Read and adhere the NixOS [[Manual of Style]] to ensure consistency across the wiki. |
| * '''Engage with the community:''' Join discussions on platforms like the [https://github.com/NixOS/nixos-wiki-infra GitHub Wiki Repository]. Active participation can highlight areas where documentation needs improvement. | | * Consider browsing the [https://wiki.nixos.org/wiki/Special:SpecialPages Special Pages] directory which contains useful links for understanding the Wiki's structure and for finding things to improve or create. |
| | * Join the relevant [[MatrixRooms|Matrix room]] |
|
| |
|
| ==== 2.2 Contributing Content ==== | | === Contributing to the infrastructure === |
| Contributions to the NixOS Wiki involve creating new pages or editing existing ones to improve clarity and relevance:
| |
| | |
| * '''Create a wiki account:''' Register an account on the NixOS Wiki to start contributing. This allows you to create and edit pages directly.
| |
| * '''Identify areas for improvement:''' Review current wiki pages to find gaps or areas that could benefit from more detailed explanations. Focus on topics that are frequently discussed or updated in the community forums.
| |
| * '''Understand the wiki structure:''' Familiarize yourself with the wiki's category system to ensure your contributions are properly organized and easily discoverable.
| |
| | |
| ==== 2.3 writing and editing wiki pages ====
| |
| Follow these guidelines when writing or editing content on the NixOS Wiki:
| |
| | |
| * '''Learn the syntax:''' The NixOS Wiki uses MediaWiki markup. Familiarize yourself with this syntax to format your contributions effectively.
| |
| * '''Provide context and examples:''' Ensure content is clear and understandable. Include examples and practical advice to help users implement solutions effectively. When possible, provide both simple and advanced examples to cater to users of different skill levels.
| |
| * '''Linking:''' Use internal wiki links to connect related pages and external links to reputable sources for further reading. This helps users navigate through related topics seamlessly. Add them to the "References" category too.
| |
| * '''Use templates:''' Use existing wiki templates to maintain consistency across pages and provide standardized information.
| |
| | |
| ==== 2.4 Submitting edits ====
| |
| Once you've prepared your contributions, submit them to the NixOS Wiki:
| |
| | |
| * '''Save page:''' Use the wiki's editing interface to save the changes directly. Preview your edits to ensure they appear as intended before saving.
| |
| * '''Document changes:''' Write a concise summary of your edits in the edit summary box. This informs other contributors about the purpose of your changes and helps maintain a clear edit history.
| |
| * '''Follow the style guide:''' Adhere to the NixOS [[Manual of Style]] to ensure consistency across the wiki.
| |
| | |
| ==== 2.5 Engaging in discussions ====
| |
| Stay connected with the NixOS Wiki community to foster collaboration and knowledge sharing:
| |
| | |
| * '''Discuss changes:''' Participate in discussions on the wiki's discussion pages or relevant community forums. Solicit feedback on proposed changes to refine content and ensure accuracy.
| |
| * '''Review and update:''' Regularly review existing wiki pages to keep information current. Update content based on new features, community feedback, or changes in the NixOS environment.
| |
| | |
| ==== 2.6 Advanced contributions ====
| |
| For those looking to make more significant contributions:
| |
| | |
| * '''Create new sections:''' Identify and propose new sections or categories that could benefit the wiki's structure and organization.
| |
| * '''Categorize articles:''' You can [[Mark articles with category tags|categorise pages adding one or more category tags]].
| |
| * '''Translate content:''' Help make the NixOS Wiki more accessible by contributing translations to other languages.
| |
| * '''Develop wiki tools:''' If you have programming skills, consider contributing to tools that can help maintain and improve the wiki, such as bots for automated tasks or extensions to enhance wiki functionality.
| |
| | |
| ==== 2.7 Conclusion ====
| |
| Contributing to the official NixOS Wiki allows you to improve the community's knowledge base and support users in adopting and maintaining NixOS effectively. By adhering to these guidelines and actively engaging with the community, you play a vital role in improving the accessibility and comprehensiveness of NixOS documentation.
| |
| | |
| Remember that the NixOS Wiki is a living document, continuously evolving with the NixOS ecosystem. Your contributions, no matter how small, are valuable in keeping this resource up-to-date and helpful for users worldwide.
| |
| | |
| == References ==
| |
| * [https://www.divio.com/en/blog/documentation/ Types of documentation]
| |
|
| |
|
| | The configuration is hosted on [https://github.com/NixOS/nixos-wiki-infra/ GitHub]. Discussions take place there, as well as in the [[MatrixRooms|Matrix room]], and during the documentation team meetings, which are public. |
|
| |
|
| [[Category:Development]] | | [[Category:Development]] |
It is possible to contribute to Nix(OS) in different ways:
Contributing to Nix
See the Nix repository contribution guide.
Contributing to Nixpkgs
Contributing to Nixpkgs, the package repository for the Nix package manager, helps maintain and improve the ecosystem of software available to Nix users.
Contributing to the documentation
Reference documentation and learning materials for using Nix standalone are maintained on nix.dev by the Nix documentation team.
See Contributing Documentation for how you can help.
Contributing to the Official NixOS Wiki
Contributing to the content
- Read and adhere the NixOS Manual of Style to ensure consistency across the wiki.
- Consider browsing the Special Pages directory which contains useful links for understanding the Wiki's structure and for finding things to improve or create.
- Join the relevant Matrix room
Contributing to the infrastructure
The configuration is hosted on GitHub. Discussions take place there, as well as in the Matrix room, and during the documentation team meetings, which are public.
