1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 14:32:43 -04:00
Commit graph

62 commits

Author SHA1 Message Date
Julien Malka e33336ff18
point wiki links to official wiki 2024-04-01 16:07:12 +02:00
Valentin Gagarin afc29b4f02 move to the nix.dev section
the text was originally written for nix.dev, so it needs to be placed
appropriately
2024-02-27 03:02:40 +01:00
Valentin Gagarin 21b8fa5c53 replace repeated "which" 2024-02-27 03:02:40 +01:00
Valentin Gagarin 7ad0041650 contributing: Add section on how to help 2024-02-27 03:02:40 +01:00
Valentin Gagarin a895f414ee
reword tutorial-writing guide (#917) 2024-02-15 19:03:51 +01:00
Valentin Gagarin 49dcd7a59f
update contributing guides (#899)
* update contributing guides

- clarify a few phrases
- move Open Collective link to the top
- add section headings for easier navigation
- add a few details on contacting people

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-02-13 10:31:30 +00:00
BOHverkill 73c25c483c
Replace mobile Wikipedia links with desktop ones (#914)
Wikipedia automatically redirects mobile users to the mobile version
when clicking a desktop link, but doesn't do the same the other way
around. This also introduces consistency, as some Wikipedia links use
the desktop version and some the mobile version.
2024-02-11 19:39:29 +00:00
BOHverkill faf23957b0
Fix link to Nix manual in contributing doc (#915) 2024-02-11 11:14:15 +00:00
Valentin Gagarin e0e2f95866
endorse CC-BY-SA for independent work (#894) 2024-02-06 05:03:01 +01:00
Valentin Gagarin 22bedeaba0
front page: Who is Nix for? (#872)
* front page: Who is Nix for?

For at least two years there were ongoing debates about the target
audience of the Nix ecosystem. Nix maintainers did not manage to
converge on a statement [0]. The marketing team is explicitly focusing
on software developers [1], and the documentation team was supposed to
align with that from the very beginning [2].

What was missing so far was what we mean by "software developers".
Arguably, it encompasses a particular mind set about how to deal with
computers and enough time to learn things.

And while for documentation it matters most *what* the software is doing
rather than *who* it is made for (or by), the ecosystem is a community
effort, and people matter [3]. So far, we haven't really identified the
(eventual) boundaries of this community (at least I don't know of any
serious attempt), which also plays into the definition of a target
audience. Yet, in practice, not every contribution, not every question
or comment is treated equally, and this has reasons in our implicit
assumptions about who belongs.

This is an attempt to draw such a boundary that is not arbitrary, and
neither to narrow nor too wide. The goal is, as always, to help
Nix beginners set realistic expectations for their journey.

The list of occupations/interests who may benefit from Nix is based on
the 2022 [4] and 2023 [5] community surveys.

[0]: https://github.com/NixOS/nix/pull/7156
[1]: 76d42a052d/community/teams/marketing.tt (L89)
[2]: https://discourse.nixos.org/t/2022-06-15-documentation-team-meeting-notes-1/20004
[3]: https://discourse.nixos.org/t/zurich-23-05-zhf-hackathon-and-workshop-report/29093#ux-workshop-21
[4]: https://discourse.nixos.org/t/2022-nix-survey-results/18983
[5]: https://discourse.nixos.org/t/nix-community-survey-2023-results/33124

Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>
2024-02-02 01:29:40 +01:00
Valentin Gagarin 8264c846ef link to new Nix reference manual page 2023-11-27 07:31:32 +01:00
Lorenzo Manacorda ca15343a1a Fix spell checking errors 2023-11-13 13:46:03 +01:00
Valentin Gagarin 3373822a7b
remove learning journey working group (#776)
- move tutorial process into the contribution guide
- move documentation survey in the maintainers directory
2023-10-30 17:04:14 +01:00
Valentin Gagarin 3a52c0ac05
add Recipes section under Guides category (#775)
* add Recipes section under Guides category

This also removes the templates section, as we're not maintaining it and it likely won't be necessary anyway once the curriculum is roughly finished.
2023-10-27 17:09:16 +02:00
Valentin Gagarin eb0825d6fe
style guide: remove duplicate quote, reword (#758) 2023-10-25 11:30:05 +02:00
fricklerhandwerk ef8c0b72ab refer to contributing guides in the respective projects
this is where the information will be most up-to-date and where it
should be maintained to begin with.
2023-10-19 12:17:00 +02:00
Lorenzo Manacorda 1dcc111a4d *: fix editorconfig errors 2023-10-06 10:59:27 +02:00
Valentin Gagarin 50007ff30b nest documentation stuff one level deeper 2023-09-07 12:06:29 +02:00
Valentin Gagarin eda059a1c9 move diataxis summary to separate page 2023-09-07 12:06:29 +02:00
Alexander Groleau 761d7de5e2
fix typo in contributing documentation 2023-09-06 13:12:30 -05:00
Valentin Gagarin 783913c8cd
highlight call for donations (#703) 2023-08-29 21:07:48 +02:00
Zach Mitchell 248a0bf6f8 Update with review comments 2023-08-10 07:42:49 -06:00
Zach Mitchell 35c1df9789 Update with review comments 2023-08-09 22:34:44 -06:00
Zach Mitchell a096fdce5c Add a summary of the Diataxis framework 2023-08-09 22:34:42 -06:00
Yuki Langley c7f17eb77e
Update diataxis links (#669) 2023-08-01 11:40:40 +02:00
Zach Mitchell, PhD 2781cb48a7
Merge pull request #664 from zmitchell/fix-diataxis-link
Fix broken Diataxis links
2023-07-27 08:57:59 -06:00
Zach Mitchell ba3104a14b Fix broken Diataxis links 2023-07-27 08:45:51 -06:00
Valentin Gagarin def3fbd071 add pointers for making donations 2023-07-21 09:32:41 +02:00
Valentin Gagarin 875cb4ae06 expand contribution guidelines
in particular, give more concrete tips on filing issues.
this is based on experience with helping to maintain Nix and trying to make
sense of what's going on in Nixpkgs.
2023-07-21 09:32:41 +02:00
Valentin Gagarin 239f0607ea strip trailing whitespace 2023-07-20 15:15:02 +02:00
Valentin Gagarin ea9def69c7 fix typos 2023-07-20 15:14:35 +02:00
Valentin Gagarin b5a568c57e
fix typo 2023-07-20 13:44:29 +02:00
Henrik 2c3083cf32
Update source/contributing/documentation.md
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:25:45 +01:00
Henrik dd2d348513
Update source/contributing/documentation.md
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:24:22 +01:00
Henrik 056d4f2938
Update source/contributing/documentation.md
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:24:05 +01:00
Henrik e0677bc570
Update source/contributing/documentation.md
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:23:53 +01:00
i97henka 23c5bade2a adding how to help on pills. 2023-07-17 16:16:26 +01:00
Henrik b1756bd187
Update source/contributing/documentation.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-07-17 16:05:07 +01:00
i97henka 10b936f6d8 adding nix pills to external sources. 2023-07-16 12:55:17 +01:00
Zach Mitchell 2592019afc Fix more broken links 2023-07-13 06:57:31 -06:00
Zach Mitchell 614e04fe81 Fix broken link 2023-07-13 06:57:31 -06:00
Zach Mitchell a3d9c019b1 Merge writing-style and style-guide 2023-07-13 06:57:31 -06:00
Zach Mitchell 00348edd0c Add style guide 2023-07-13 06:57:31 -06:00
Yuki Langley 9aaa97a8b0
Make home page cards clickable (#616) 2023-06-25 14:13:20 +02:00
Valentin Gagarin 2ae6b07a97
move more writing style recommendations into the public guide (#607) 2023-06-22 11:18:22 +02:00
alex 0c933bd9e8 Move writing style to separate page 2023-06-19 11:25:29 -05:00
Valentin Gagarin 0bd24f7408
update contribution guide concerning the wiki 2023-05-31 02:18:55 +02:00
nikstur 19f59af2d8
contributing: fix link (#568) 2023-05-19 09:41:51 +02:00
Valentin Gagarin 3c857b4589
improve wording in contribution guide (#549)
* improve wording in contribution guide
2023-05-16 00:41:00 +02:00
Lorenzo Manacorda 8834f94a67 integrate feedback and fix some issues 2023-04-29 21:50:42 +02:00