Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: NixOS/nixos-homepage
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 53c24632dfd0
Choose a base ref
...
head repository: NixOS/nixos-homepage
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 36ab0be5b074
Choose a head ref
  • 1 commit
  • 8 files changed
  • 1 contributor

Commits on Mar 24, 2020

  1. Documentation overview page (#357) 

    Documentation overview page

Two things were done in this patch:

1. There is only one Learn page which all learning material on there. It
   used to be the case that each project had (or didn't have) a Learn item
   in the navigation bar. In some cases the item in the navigation bar was
   called Manual which broke the consistency of the website and most
   importantly the expectations of the visitor.

2. An opinionated overview of the content of the manuals was created. I
   tried to avoid to much work and instead of changing the manuals I
   created a table of content which I believe newcomers will be more
   interested in. I'm not saying this is how table of content should
   look like, but it is a start we can build upon. Most importantly is
   that we keep in mind that target audience for this page are newcomers
   and visitors not that familiar with nix ecosystem.
    @garbas
    garbas authored Mar 24, 2020
    1
    Copy the full SHA
    36ab0be View commit details
Showing with 160 additions and 85 deletions.
  1. +2 −2 Makefile
  2. +1 −1 README.md
  3. +4 −4 index.tt
  4. +4 −3 layout.tt
  5. +147 −0 learn.tt
  6. +1 −1 nixos/community.tt
  7. +0 −73 nixos/learn.tt
  8. +1 −1 nixos/wiki.tt
4 changes: 2 additions & 2 deletions Makefile
View file
Original file line number Diff line number Diff line change
@@ -7,10 +7,10 @@ rwildcard=$(foreach d,$(wildcard $1*),$(call rwildcard,$d/,$2) $(filter $(subst
default: all


HTML = index.html news.html \
HTML = index.html news.html learn.html \
nix/index.html nix/about.html nix/download.html \
nixpkgs/index.html nixpkgs/download.html \
nixos/index.html nixos/about.html nixos/download.html nixos/learn.html \
nixos/index.html nixos/about.html nixos/download.html \
nixos/community.html nixos/packages.html nixos/options.html \
nixos/security.html nixos/foundation.html \
nixos/wiki.html \
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ build it:
$ cd nixos-homepage
$ nix-shell
[nix-shell]$ make
[nix-shell]$ python2 -m SimpleHTTPServer 8000
[nix-shell]$ python -m http.server 8000

then open http://127.0.0.1:8000/index.html

8 changes: 4 additions & 4 deletions index.tt
View file
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@
</p>

<div class="learn-more">
<a class="btn btn-success" href="[%root%]nix/">
<a class="btn btn-success" href="[%root%]/nix/">
<i class="fa fa-chevron-right"></i> Learn more about Nix
</a>
</div>
@@ -35,10 +35,10 @@
to package and configuration management. Built on top of the
Nix package manager, it is completely declarative, makes
upgrading systems reliable, and has
<a href="[%root%]nixos/about.html">many other advantages</a>.</p>
<a href="[%root%]/nixos/about.html">many other advantages</a>.</p>

<div class="learn-more">
<a class="btn btn-success" href="[%root%]nixos/">
<a class="btn btn-success" href="[%root%]/nixos/">
<i class="fa fa-chevron-right"></i> Learn more about NixOS
</a>
</div>
@@ -89,7 +89,7 @@
</a>
</li>
<li>
<a href="[%root%]/nixos/learn.html">
<a href="[%root%]/learn.html">
Learning resources
<i class="fa fa-angle-right"></i>
</a>
7 changes: 4 additions & 3 deletions layout.tt
View file
Original file line number Diff line number Diff line change
@@ -66,7 +66,7 @@
<ul class="nav pull-left">
<li><a href="[%root%]nixos/about.html">About</a></li>
<li><a href="[%root%]nixos/download.html">Download</a></li>
<li><a href="[%root%]nixos/learn.html">Learn</a></li>
<li><a href="[%root%]learn.html">Learn</a></li>
<li><a href="[%root%]nixos/packages.html">Packages</a></li>
<li><a href="[%root%]nixos/options.html">Options</a></li>
<li><a href="[%root%]nixos/community.html">Community</a></li>
@@ -81,19 +81,20 @@
<ul class="nav pull-left">
<li><a href="[%root%]nix/about.html">About</a></li>
<li><a href="[%root%]nix/download.html">Download</a></li>
<li><a href="[%root%]nix/manual/">Manual</a></li>
<li><a href="[%root%]learn.html">Learn</a></li>
</ul>
<ul class="nav pull-right">
<li><a href="https://github.com/NixOS/nix"><i class="fa fa-github"></i></a></li>
[% ELSIF menu == 'nixpkgs' %]
<ul class="nav pull-left">
<li><a href="[%root%]nixpkgs/download.html">Download</a></li>
<li><a href="[%root%]nixpkgs/manual">Manual</a></li>
<li><a href="[%root%]learn.html">Learn</a></li>
</ul>
<ul class="nav pull-right">
<li><a href="https://github.com/NixOS/nixpkgs"><i class="fa fa-github"></i></a></li>
[% ELSIF menu == 'organization' %]
<ul class="nav pull-right">
<li><a href="[%root%]learn.html">Learn</a></li>
<li><a href="https://github.com/NixOS/nixpkgs"><i class="fa fa-github"></i></a></li>
<li><a href="https://twitter.com/nixos_org"><i class="fa fa-twitter"></i></a></li>
[% ELSE %]
147 changes: 147 additions & 0 deletions learn.tt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
[% WRAPPER layout.tt hideTitle=1 title="Learn" menu='nixos' %]

<div class="row-fluid">

<div class="span4">
<h2>Learn Nix</h2>
<p>Nix is a package manager which comes in a form of many command line tools.
Packages that Nix can build are defined with Nix Expression Language.
</p>
<ul>
<li><a href="[%root%]/nix/manual/#ch-installing-binary">Installation</a></li>
<li><a href="[%root%]/nix/manual/#ch-basic-package-mgmt">Basic package management</a></li>
<li><a href="[%root%]/nix/manual/#sec-channels">What is a channel?</a></li>
<li>
Main command line tools:
<ul>
<li><a href="[%root%]/nix/manual/#sec-nix-env">nix-env</a> — manipulate or query Nix user environments</li>
<li><a href="[%root%]/nix/manual/#sec-nix-build">nix-build</a> — build a Nix expression</li>
<li><a href="[%root%]/nix/manual/#sec-nix-shell">nix-shell</a> — start an interactive shell based on a Nix expression</li>
<li><a href="[%root%]/nix/manual/#sec-nix-store">nix-store</a> — manipulate or query the Nix store</li>
</ul>
</li>
<li>
<a href="[%root%]/nix/manual/#ch-expression-language">Nix expression language</a>
<ul>

<li><a href="[%root%]/nix/manual/#ssec-builtins">Built-in functions</a></li>
<li><a href="[%root%]/nixpkgs/manual/#sec-functions-library">Nixpkgs Library Functions</a></li>
<li><a href="[%root%]/nixpkgs/manual/#sec-debug">Debugging Nix Expressions</a></li>
</ul>
</li>
</ul>
<a href="[%root%]/nix/manual" class="btn btn-block">More ...</a>
</div>

<div class="span4">
<h2>Learn Nixpkgs</h2>
<p>The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the Nix package manager and NixOS linux distribution.</p>
<ul>
<li><a href="[%root%]/nixpkgs/manual/#chap-packageconfig">Configure nixpkgs</a></li>
<li><a href="[%root%]/nixpkgs/manual/#chap-overrides">Customize packages (override packages)</a></li>
<li><a href="[%root%]/nixpkgs/manual/#chap-overlays">Extend nixpkgs (via overlays)</a></li>
<li>
<a href="[%root%]/nixpkgs/manual/#chap-quick-start">Adding a package to nixpkgs</a>
<ul>
<li><a href="[%root%]/nixpkgs/manual/#chap-stdenv">The Standard Environment</a></li>
<li><a href="[%root%]/nixpkgs/manual/#chap-pkgs-fetchers">Fetching sources</a></li>
<li>
Building images:
<a href="[%root%]/nixpkgs/manual/#sec-pkgs-dockerTools">Docker</a>,
<a href="[%root%]/nixpkgs/manual/#sec-pkgs-snapTools">Snap</a>,
<a href="[%root%]/nixpkgs/manual/#sec-pkgs-appimageTools">AppImage</a>,
<a href="[%root%]/nixpkgs/manual/#sec-pkgs-ociTools">OCI</a>,
...
</li>
</ul>
</li>
<li>
Integrate Nix with programming languages:
<a href="[%root%]/nixpkgs/manual/#node.js">Javascript (Node)</a>,
<a href="[%root%]/nixpkgs/manual/#python">Python</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-ruby">Ruby</a>
<a href="[%root%]/nixpkgs/manual/#sec-language-java">Java</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-go">Go</a>,
<a href="[%root%]/nixpkgs/manual/#rust">Rust</a>,
<a href="[%root%]/nixpkgs/manual/#r">R</a>,
<a href="[%root%]/nixpkgs/manual/#haskell">Haskell</a>,
<a href="[%root%]/nixpkgs/manual/#sec-elm">Elm</a>,
<a href="[%root%]/nixpkgs/manual/#sec-beam">BEAM Languages (Erlang, Elixir, LFE)</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-lua">Lua</a>,
<a href="[%root%]/nixpkgs/manual/#idris">Idris</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-coq">Coq</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-perl">Perl</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-ocaml">OCaml</a>,
...
</li>
<li>
Integrate Nix with frameworks:
<a href="[%root%]/nixpkgs/manual/#android">Android</a>,
<a href="[%root%]/nixpkgs/manual/#ios">IOS</a>,
<a href="[%root%]/nixpkgs/manual/#titanium">Titanium</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-texlive">Tex Live</a>,
<a href="[%root%]/nixpkgs/manual/#sec-language-qt">Qt</a>,
...
</li>
<li>
Configure your editor with Nix:
<a href="[%root%]/nixpkgs/manual/#vim">Vim</a>,
<a href="[%root%]/nixpkgs/manual/#sec-emacs">Emacs</a>,
<a href="[%root%]/nixpkgs/manual/#sec-eclipse">Eclipse</a>,
<a href="[%root%]/nixpkgs/manual/#sec-kakoune">Kakoune</a>,
<!-- TODO
<a href="[%root%]/nixpkgs/manual/#">Visual Studio Code</a>,
-->
...
</li>
<li><a href="[%root%]/nixpkgs/manual/#chap-submitting-changes">Contributing to Nixpkgs</a></li>
</ul>
<a href="[%root%]/nixpkgs/manual" class="btn btn-block">More ...</a>
</div>

<div class="span4">
<h2>Learn NixOS</h2>
<p>NixOS is a Linux distribution based on Nix package manager.</p>
<ul>
<li><a href="[%root%]/nixos/manual/#sec-installation">Installing NixOS</a></li>
<li><a href="[%root%]/nixos/manual/#sec-changing-config">Changing the Configuration</a></li>
<li><a href="[%root%]/nixos/manual/#sec-upgrading">Upgrading NixOS</a></li>
<li><a href="[%root%]/nixos/manual/#sec-configuration-syntax">Configuration Syntax</a></li>
<li><a href="[%root%]/nixos/manual/#sec-package-management">Package Management</a></li>
<li><a href="[%root%]/nixos/manual/#sec-user-management">User Management</a></li>
<li><a href="[%root%]/nixos/manual/#ch-troubleshooting">Troubleshooting</a></li>
<li><a href="[%root%]/nixos/manual/#sec-writing-modules">Writing NixOS Modules</a></li>
<li><a href="[%root%]/nixos/manual/#sec-writing-documentation">Writing NixOS Documentation</a></li>
<li><a href="[%root%]/nixos/manual/#sec-nixos-tests">Writing NixOS Tests</a></li>
<li><a href="[%root%]/nixos/manual/#sec-building-cd">Building Your Own NixOS CD</a></li>
</ul>
<a href="[%root%]/nixos/manual" class="btn btn-block">More ...</a>
</div>

</div>

<div class="row-fluid">

<div class="span6">
<h2>Other learning resources</h2>
<ul>
<li>
<a href="[%root%]/nixos/nix-pills">Nix Pills</a> — At the beginning you may feel that some of the magic which happens behind the scenes is hard to grasp. This series aims to complement the existing explanations from the more This wiki is user-maintained. formal documents.</li>
<li><a href="https://nixos.wiki">Wiki</a> — A user-maintained wiki for Nix and NixOS.</li>
<li><a href="https://nix-cookbook.readthedocs.io">Nix cookbook</a> — Nix Community Cookbook presents topical, practical ways of using Nix package manager ecosystem.</li>
</ul>
</div>

<div class="span6">
<h2>Get help from the community</h2>
<ul>
<li><a href="https://discourse.nixos.org/">Discourse</a> — Discourse is a forum where we have discussions and help users out with their questions.</li>
<li><a href="irc://irc.freenode.net/#nixos">IRC</a> — You can drop by on the IRC channel <a href="irc://irc.freenode.net/#nixos"><strong><tt>#nixos</tt></strong></a> on <a href="https://freenode.net/"><tt>irc.freenode.net</tt></a> to chat with the developers or other users.</li>
<li><a href="https://stackoverflow.com/questions/tagged/nixos">Stackoverflow</a> — a place to ask questions.</li>
<li><a href="https://www.reddit.com/r/NixOS">Reddit</a> — a place to discuss Nix / NixOS.</li>
</ul>
</div>

</div>

[% END %]
2 changes: 1 addition & 1 deletion nixos/community.tt
View file
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@
please open a <a
href="https://github.com/NixOS/nixpkgs/pulls"><strong>pull request on
GitHub</strong></a>, or <strong>send a patch</strong> to the <a
href="[%root%]nixos/learn.html#discourse"><tt>Discourse</tt> forum</a>. If you
href="[%root%]learn.html#discourse"><tt>Discourse</tt> forum</a>. If you
want to contribute regularly, you may want to ask for commit access to
our GitHub repositories (please ask <a
href="https://nixos.org/~eelco/">Eelco</a>, or on the <tt>#nixos</tt>
73 changes: 0 additions & 73 deletions nixos/learn.tt
View file

This file was deleted.

2 changes: 1 addition & 1 deletion nixos/wiki.tt
View file
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@
<li><a href="[%root%]nix/manual/">Nix Manual</a> for help
with the Nix expression language, Nix tools, and Nix's management
model.</li>
<li><a href="[%root%]nixos/learn.html">NixOS Support Page</a>
<li><a href="[%root%]learn.html">NixOS Support Page</a>
on NixOS.org</li>
</ul>