diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..acb60ea --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +nix-community.org \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3ae6b2d --- /dev/null +++ b/docs/README.md @@ -0,0 +1,58 @@ +<img src="nix-community-logo.svg" width="100" height="100" alt="Nix community"> +The @nix-community is a GitHub organization that works alongside the @NixOS organization. + +The mission critical projects are hosted in the @NixOS organization. This is our playground. Maximal freedom! + +If you want to do something and it doesn't interfer with other people's +project then we are here to support you. + +## Infrastructure + +To support our activities we have a little bit of infrastructure in place. + +See https://github.com/nix-community/infra for the list of services and configuration. + +### Binary cache + +All the build results are being pushed to https://nix-community.cachix.org/ + +See https://app.cachix.org/cache/nix-community for the installation instructions. + +## FAQ + +### What role does the @nix-community org play in the Nix ecosystem? + +The @NixOS organization holds all the mission-critical projects such as Nix, Nixpkgs, NixOps, Hydra, etc. + +The @nix-community is the community playground. We don't need to be as strict with permissions. The org can host any projects that benefit from a shared ownership. We provide infrastructure and support for those projects as well as visibility. + +### How do I get my project included? + +Ideally the type of projects that are accepted have some level of maturity and can benefit from a shared ownership. The goal is to have as much projects maintained and not for the org to become a graveyard. + +We don't have a strict procedure. For now, ping one of the [org owners](#org-owners). + +### What are the rules of engagement? + +The Nix community is nice. Be nice! Typically this means: + +1. Argument on technical details, not the people. +2. Give the benefit of the doubt as much as possible. We all have different lives with different backgrounds. +3. Keep in mind that all the work here is done by volunteers. +4. :) + +Nothing is set in stone. Think of these as the guidelines for our interactions. + +The maintainer of a project gets admin access to the project they maintain. The maintainer is allowed to invite more people into the org and into their team. + +If you see a project that is under-maintained, submit PRs to fix it as if it was your own project. If the PRs don't get merged, ping the [org owners](#org-owners) + +### Org owners + +If you need to contact the org owners, see [the list of org owners](https://github.com/orgs/nix-community/people?utf8=%E2%9C%93&query=+role%3Aowner). + +Come chat with us in [#nix-community](https://matrix.to/#/#nix-community:nixos.org) using the matrix protocol! + +## Sponsors + +<img src="https://raw.githubusercontent.com/cachix/cachix/master/logo.png" width="200" alt="Cachix"> provides us with a free 1TB binary cache! diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..86af181 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,24 @@ +theme: jekyll-theme-primer +url: "https://nix-community.github.io" + +# see https://github.com/github/pages-gem/blob/754a725e4766d4329bb1dd0e07c638a045ad2c04/lib/github-pages/plugins.rb#L6-L42 +plugins: + - jemoji + - jekyll-avatar + - jekyll-default-layout + - jekyll-feed + - jekyll-mentions + - jekyll-readme-index + - jekyll-sitemap + +markdown: CommonMarkGhPages +# see https://github.com/gjtorikian/commonmarker#parse-options +commonmark: + options: + - FOOTNOTES + - SMART + - UNSAFE + extensions: + - autolink + - strikethrough + - table diff --git a/docs/nix-community-logo.png b/docs/nix-community-logo.png new file mode 100644 index 0000000..54b107e Binary files /dev/null and b/docs/nix-community-logo.png differ diff --git a/docs/nix-community-logo.svg b/docs/nix-community-logo.svg new file mode 100644 index 0000000..684bc6d --- /dev/null +++ b/docs/nix-community-logo.svg @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="136.68491mm" + height="136.68491mm" + viewBox="0 0 484.31659 484.31659" + id="svg2" + version="1.1" + inkscape:version="0.92.4 (5da689c313, 2019-01-14)" + sodipodi:docname="nix-community-logo.svg"> + <defs + id="defs4" /> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="0.0" + inkscape:pageshadow="2" + inkscape:zoom="0.34760742" + inkscape:cx="-173.38017" + inkscape:cy="186.45699" + inkscape:document-units="px" + inkscape:current-layer="svg2" + showgrid="false" + inkscape:window-width="2560" + inkscape:window-height="1080" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + fit-margin-top="0" + fit-margin-left="0" + fit-margin-right="0" + fit-margin-bottom="0" /> + <g + inkscape:label="print-logo" + inkscape:groupmode="layer" + id="layer1" + style="display:inline" + sodipodi:insensitive="true" + transform="translate(-132.5822,958.04022)"> + <path + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5277c3;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" + d="m 309.40365,-710.2521 122.19683,211.6751 -56.15706,0.5268 -32.6236,-56.8692 -32.85645,56.5653 -27.90237,-0.011 -14.29086,-24.6896 46.81047,-80.4902 -33.22946,-57.8256 z" + id="path4861" + inkscape:connector-curvature="0" + sodipodi:nodetypes="cccccccccc" /> + <path + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#7ebae4;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" + d="m 353.50926,-797.4433 -122.21756,211.6631 -28.53477,-48.37 32.93839,-56.6875 -65.41521,-0.1719 -13.9414,-24.1698 14.23637,-24.721 93.11177,0.2939 33.46371,-57.6903 z" + id="use4863" + inkscape:connector-curvature="0" + sodipodi:nodetypes="cccccccccc" /> + <path + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#7ebae4;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" + d="m 362.88537,-628.243 244.41439,0.012 -27.62229,48.8968 -65.56199,-0.1817 32.55876,56.7371 -13.96098,24.1585 -28.52722,0.032 -46.3013,-80.7841 -66.69317,-0.1353 z" + id="use4865" + inkscape:connector-curvature="0" + sodipodi:nodetypes="cccccccccc" /> + <path + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#7ebae4;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" + d="m 505.14318,-720.9886 -122.19683,-211.6751 56.15706,-0.5268 32.6236,56.8692 32.85645,-56.5653 27.90237,0.011 14.29086,24.6896 -46.81047,80.4902 33.22946,57.8256 z" + id="use4867" + inkscape:connector-curvature="0" + sodipodi:nodetypes="cccccccccc" /> + <path + sodipodi:nodetypes="cccccccccc" + inkscape:connector-curvature="0" + id="path4873" + d="m 309.40365,-710.2521 122.19683,211.6751 -56.15706,0.5268 -32.6236,-56.8692 -32.85645,56.5653 -27.90237,-0.011 -14.29086,-24.6896 46.81047,-80.4902 -33.22946,-57.8256 z" + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5277c3;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" /> + <path + sodipodi:nodetypes="cccccccccc" + inkscape:connector-curvature="0" + id="use4875" + d="m 451.3364,-803.53264 -244.4144,-0.012 27.62229,-48.89685 65.56199,0.18175 -32.55875,-56.73717 13.96097,-24.15851 28.52722,-0.0315 46.3013,80.78414 66.69317,0.13524 z" + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5277c3;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" /> + </g> +</svg>