Compare commits
3 commits
93cd11eba4
...
9269687c6d
| Author | SHA1 | Date | |
|---|---|---|---|
 dfh
|
9269687c6d | ||
|
dfh
|
26dbc30f4c | ||
|
dfh
|
2f18806425 |
17
.editorconfig
Normal file
17
.editorconfig
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
indent_style = tabs
|
||||
|
||||
[*.nix]
|
||||
indent_size = 2
|
||||
indent_style = space
|
||||
|
||||
[*.md]
|
||||
indent_size = 2
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: Resources
|
||||
description: resources for getting started or learning more
|
||||
published: true
|
||||
date: 2024-07-11T19:13:31.908Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-30T17:18:44.151Z
|
||||
|
|
@ -45,7 +45,9 @@ Despite the name, this wiki covers topics related to Nix, NixOS and Nixpkgs.
|
|||
# Manuals / References
|
||||
|
||||
## [Nix](https://nix.dev/reference/nix-manual)
|
||||
|
||||
## [Nixpkgs](https://nixos.org/manual/nixpkgs/stable/)
|
||||
|
||||
## [NixOS](https://nixos.org/manual/nixos/stable/)
|
||||
|
||||
# Search engines
|
||||
|
|
@ -58,7 +60,6 @@ Searches Nix and Nixpkgs builtins and lib.
|
|||
|
||||
Searches nixpkgs options and packages, as well as nix-darwin and home-manager options.
|
||||
|
||||
|
||||
## [NixOS Search](https://search.nixos.org/packages)
|
||||
|
||||
Searches NixOS packages and options.
|
||||
|
|
@ -70,6 +71,7 @@ Searches home manager options.
|
|||
# Other
|
||||
|
||||
## [Nix Resources recommended by Lix](https://lix.systems/resources/)
|
||||
|
||||
## [nix.dev](https://nix.dev)
|
||||
|
||||
[nix.dev](https://nix.dev) is an official resource, owned and maintained by the [NixOS documentation team](https://nixos.org/community/teams/documentation/).
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: Code of Conduct
|
||||
description: The Aux Code of Conduct
|
||||
published: true
|
||||
date: 2024-08-01T23:44:00.000Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-18T21:55:33.415Z
|
||||
|
|
@ -13,6 +13,7 @@ dateCreated: 2024-05-18T21:55:33.415Z
|
|||
The Aux ecosystem is governed by [the Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). Please read through it to understand the acceptable behavior within this community and what actions may be taken by moderators to resolve infractions. If something is wrong, please message the moderators.
|
||||
|
||||
## Contributor Covenant Code of Conduct
|
||||
|
||||
> The Contributor Covenant was created by [Coraline Ada Ehmke](https://where.coraline.codes/) in 2014 and is released under the [CC BY 4.0 License](https://github.com/EthicalSource/contributor_covenant/blob/release/LICENSE.md), **not** the MIT license which other portions of the wiki are under.
|
||||
>
|
||||
> For more details, see the "Attribution" section.
|
||||
|
|
@ -20,7 +21,6 @@ The Aux ecosystem is governed by [the Contributor Covenant](https://www.contribu
|
|||
> Please do not remove this notice
|
||||
> {.is-info}
|
||||
|
||||
|
||||
### Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
|
|
@ -38,23 +38,23 @@ diverse, inclusive, and healthy community.
|
|||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
- Demonstrating empathy and kindness toward other people
|
||||
- Being respectful of differing opinions, viewpoints, and experiences
|
||||
- Giving and gracefully accepting constructive feedback
|
||||
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the overall
|
||||
- Focusing on what is best not just for us as individuals, but for the overall
|
||||
community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or advances of
|
||||
- The use of sexualized language or imagery, and sexual attention or advances of
|
||||
any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email address,
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or email address,
|
||||
without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
- Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
### Enforcement Responsibilities
|
||||
|
|
@ -151,4 +151,3 @@ For answers to common questions about this code of conduct, see the FAQ at
|
|||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Community
|
||||
description: What are SIGs and Committees? How do they differ?
|
||||
published: true
|
||||
date: 2024-05-16T22:09:09.150Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-05T16:35:17.642Z
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Committees
|
||||
description: The guide to Aux Committees
|
||||
published: true
|
||||
date: 2024-07-01T19:23:14.423Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-11T16:31:30.923Z
|
||||
|
|
@ -17,13 +17,12 @@ The ideas for committees are inspired by [the kubernetes governance](https://git
|
|||
## What Committees are there?
|
||||
|
||||
| Name | Responsibility | Current Leaders |
|
||||
|---------------|------------------------------------------------------------------------------------------------------------------|---------------------------|
|
||||
| --------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
|
||||
| Steering | Decides on the direction for Aux, for example by determining the roadmap, and oversees the formation of SIGs and Committees | @jakehamilton, @isabel, @minion |
|
||||
| Code of Conduct | Determines the Code of Conduct and oversees moderation | @axel, @isabel |
|
||||
| Marketing | Determines branding and public presence for Aux | |
|
||||
| [Security] | Determines security guidelines for SIGs, and aims to make security both excellent and accessible | @c8h4, @dfh |
|
||||
|
||||
|
||||
## Committee Meetings
|
||||
|
||||
Some committee meetings are open to everyone, whether you're a part of the committee or not. Committees are also allowed to hold private meetings among only their members, but are encouraged to make as many of their meetings public as possible. Committees which hold regular public meetings are listed below.
|
||||
|
|
@ -31,5 +30,5 @@ Some committee meetings are open to everyone, whether you're a part of the commi
|
|||
Meetings are also announced on their respective committee category on the forum before they occur. Meeting announcements include an agenda, an up-to-date meeting link, and details such as schedule changes. We recommend treating them as fully authoritative for specific meetings and taking this table as a guide for meetings you may want to attend on a regular basis.
|
||||
|
||||
| Committee | Meeting Time | Meeting length | Join Link |
|
||||
|---------------|------------------------|----------------|-------------------------------------------------|
|
||||
| ------------------------------------------ | ---------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [Security](/community/security/welcome.md) | Thursdays at 18:00 UTC | around 1 hour | [dfh's opentalk room](https://opentalk.mailbox.org/room/b7508d49-130c-48af-920d-53ebd8e3891a?invite=96dd445c-0b88-4a78-9fa4-33f6f260bbd6) |
|
||||
|
|
|
|||
|
|
@ -2,26 +2,32 @@
|
|||
title: SIG Core
|
||||
description: Information regarding Aux Core Special Interest Group
|
||||
published: true
|
||||
date: 2024-05-18T18:15:47.010Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-18T13:18:06.677Z
|
||||
---
|
||||
|
||||
# Aux Special Interest Group Core
|
||||
|
||||
## Welcome
|
||||
|
||||
On this page you'll find information about what we do. How you can contribute, and general information about the team.
|
||||
|
||||
## Mission
|
||||
|
||||
Aux SIG: Core is providing the minimum requirements to build critical things
|
||||
|
||||
## Contribute
|
||||
|
||||
TODO add way to contact the team or be keep in touch about Aux Core status.
|
||||
|
||||
- mailing list
|
||||
- RSS
|
||||
- team contact
|
||||
|
||||
## Team Members
|
||||
|
||||
- VlinkZ
|
||||
- srxl
|
||||
- c8h4
|
||||
|
|
|
|||
|
|
@ -2,13 +2,15 @@
|
|||
title: Communication
|
||||
description: How to talk with SIG Core
|
||||
published: true
|
||||
date: 2024-07-01T19:23:58.515Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-06-07T19:58:59.605Z
|
||||
---
|
||||
|
||||
# Communication
|
||||
|
||||
SIG: Core has a few different ways we can communicate. You can use any of the following:
|
||||
|
||||
- Send a message to [SIG: Core - General on Matrix](https://matrix.to/#/#SIGCORE-GEN:auxolotl.org)
|
||||
- View and comment on ongoing topics in the [Discourse Category](https://forum.aux.computer/c/special-interest-groups/sig-core/14)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Onboarding
|
||||
description: How to get involved in SIG Core
|
||||
published: true
|
||||
date: 2024-07-01T19:23:38.556Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-18T15:57:29.649Z
|
||||
|
|
@ -15,19 +15,24 @@ If you are interested in joining SIG: Core, please make sure to follow the steps
|
|||
Should any of the links below be broken or descriptions inaccurate we highly appreciate a PR with corrections.
|
||||
|
||||
## Group memberships
|
||||
1) Request your membership to the [Discourse Group "SIG: Core"](https://forum.aux.computer/g/sig_core/)
|
||||
2) Request your membership to the [Github Team "SIG: Core"](https://github.com/orgs/auxolotl/teams/sig-core)
|
||||
3) Add/ update your membership status in the [community repo])(https://github.com/auxolotl/community)
|
||||
- Add or update your user settings in [`users.nix`](https://github.com/auxolotl/community/blob/main/users.nix)
|
||||
- Add your user to list `sigs.core.members` in [`memberships.nix`](https://github.com/auxolotl/community/blob/main/memberships.nix)
|
||||
- Create a PR to add yourself to the ["Team members" in the wiki](https://github.com/auxolotl/wiki/blob/main/community/core.md).
|
||||
|
||||
Make sure to stick with the alphabetic ordering for readability!
|
||||
1. Request your membership to the [Discourse Group "SIG: Core"](https://forum.aux.computer/g/sig_core/)
|
||||
2. Request your membership to the [Github Team "SIG: Core"](https://github.com/orgs/auxolotl/teams/sig-core)
|
||||
3. Add/ update your membership status in the [community repo])(https://github.com/auxolotl/community)
|
||||
|
||||
- Add or update your user settings in [`users.nix`](https://github.com/auxolotl/community/blob/main/users.nix)
|
||||
- Add your user to list `sigs.core.members` in [`memberships.nix`](https://github.com/auxolotl/community/blob/main/memberships.nix)
|
||||
- Create a PR to add yourself to the ["Team members" in the wiki](https://github.com/auxolotl/wiki/blob/main/community/core.md).
|
||||
|
||||
Make sure to stick with the alphabetic ordering for readability!
|
||||
|
||||
## Communication channels
|
||||
|
||||
Make sure you have joined the following channels on Matrix in which ad-hoc communication takes place
|
||||
|
||||
- [SIG: Core - Governance](https://matrix.to/#/#SIGCORE-GOV:auxolotl.org)
|
||||
- [SIG: Core - General](https://matrix.to/#/#SIGCORE-GEN:auxolotl.org)
|
||||
|
||||
## Meeting notes
|
||||
|
||||
Meeting notes are being archived and tagged in the forum, they can be accessed by filtering for the [meeting-minutes tag](https://forum.aux.computer/tags/c/special-interest-groups/sig-core/14/meeting-minutes).
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Security Committee
|
||||
description: Information related to the Aux Security Committee
|
||||
published: true
|
||||
date: 2024-06-29T17:51:21.327Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags: security, cve, vulnerabilities
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-16T19:25:47.469Z
|
||||
|
|
@ -13,12 +13,13 @@ dateCreated: 2024-05-16T19:25:47.469Z
|
|||
## Welcome to the Security Committee
|
||||
|
||||
These pages contain documentation specific to the Security Committee regarding:
|
||||
|
||||
- [Onboarding/Joining](/community/security/onboarding)
|
||||
- Communication
|
||||
- Task Management
|
||||
|
||||
> If you're looking to report a vulnerability, please visit [our page on reporting vulnerabilities](https://wiki.auxolotl.org/en/community/security/report-a-security-vulnerability). These pages look at how the security committee is set up to handle security in a broader sense.
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
## Mission
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Onboarding
|
||||
description: How to get involved with COMSEC
|
||||
published: true
|
||||
date: 2024-07-01T19:24:24.404Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-12T17:02:35.590Z
|
||||
|
|
@ -15,16 +15,20 @@ If you are interested in joining COMSEC, please make sure to follow the steps li
|
|||
Should any of the links below be broken or descriptions inaccurate we highly appreciate a PR with corrections.
|
||||
|
||||
## Group memberships
|
||||
1) Request your membership to the [Discourse Group "Committee: Security"](https://forum.aux.computer/g/committee_security/). We would love for you to include an introduction post, but it's not mandatory.
|
||||
2) Poke @c8h4 and/or @dfh to ensure they also added you to the [COMSEC team @forgejo](https://git.auxolotl.org/org/auxolotl/teams/committee-security)
|
||||
3) Create a PR to add yourself to the ["Team members" in the wiki](https://git.auxolotl.org/auxolotl/wiki/src/branch/main/community/security.md)
|
||||
|
||||
Make sure to stick with the alphabetic ordering for readability!
|
||||
1. Request your membership to the [Discourse Group "Committee: Security"](https://forum.aux.computer/g/committee_security/). We would love for you to include an introduction post, but it's not mandatory.
|
||||
2. Poke @c8h4 and/or @dfh to ensure they also added you to the [COMSEC team @forgejo](https://git.auxolotl.org/org/auxolotl/teams/committee-security)
|
||||
3. Create a PR to add yourself to the ["Team members" in the wiki](https://git.auxolotl.org/auxolotl/wiki/src/branch/main/community/security.md)
|
||||
|
||||
Make sure to stick with the alphabetic ordering for readability!
|
||||
|
||||
## Communication channels
|
||||
|
||||
Make sure you have joined the following channels on Matrix in which ad-hoc communication takes place
|
||||
|
||||
- [COM: Security - Governance](https://matrix.to/#/#COMSEC-GOV:auxolotl.org)
|
||||
- [COM: Security - General](https://matrix.to/#/#COMSEC-GEN:auxolotl.org)
|
||||
|
||||
## Meeting notes
|
||||
|
||||
Meeting notes are being archived and tagged in the forum, they can be accessed by filtering for the [meeting-minutes tag](https://forum.aux.computer/tags/c/committees/security-committee/26/meeting-minutes).
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Reporting vulnerabilities
|
||||
description: How to contact COMSEC
|
||||
published: true
|
||||
date: 2024-07-01T19:24:44.929Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-06-29T17:45:54.020Z
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: SIGs
|
||||
description: Your guide to Special Interest Groups and what they do
|
||||
published: true
|
||||
date: 2024-05-18T14:18:52.958Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-05T17:22:20.994Z
|
||||
|
|
@ -17,7 +17,7 @@ The ideas for SIGs are inspired by [the kubernetes governance](https://github.co
|
|||
## What SIGs are there?
|
||||
|
||||
| Name | Responsibility | Current Leaders |
|
||||
|---------------|------------------------------------------------------------------------------------------------------------------|---------------------------|
|
||||
| ------------- | ---------------------------------------------------------------------------------------------------------------- | --------------- |
|
||||
| Core | Maintains vital software and packages for Aux to function | @vlinkz |
|
||||
| CLI | Maintains the Aux CLI and our fork of the Nix CLI | |
|
||||
| Darwin | Maintains Aux code for Darwin (MacOS) systems, for example they would be in charge of `nix-darwin`-like projects | @yamashitax |
|
||||
|
|
@ -31,7 +31,6 @@ The ideas for SIGs are inspired by [the kubernetes governance](https://github.co
|
|||
| Python | Maintains `pythonPackages`, python packaging support, and other python support for Aux | |
|
||||
| Rust | Maintains `rust` and rust packaging support for Aux | |
|
||||
|
||||
|
||||
## SIG Meetings
|
||||
|
||||
SIG meetings are open to everyone, whether you're a part of the SIG or not. SIGs which hold regular meetings are listed below.
|
||||
|
|
@ -39,6 +38,6 @@ SIG meetings are open to everyone, whether you're a part of the SIG or not. SIGs
|
|||
Meetings are also announced on their respective SIG category on the forum before they occur. Meeting announcements include an agenda, an up-to-date meeting link, and details such as schedule changes. We recommend treating them as fully authoritative for specific meetings and taking this table as a guide for meetings you may want to attend on a regular basis.
|
||||
|
||||
| SIG | Meeting Time | Meeting length | Join Link |
|
||||
|---------------|------------------------|----------------|-------------------------------------------------|
|
||||
| ------------- | --------------------------------------------------------------------------------------------------------------- | -------------- | ----------------------------------------------------- |
|
||||
| Documentation | Saturdays at 17:00 UTC | around 1 hour | [AuxSigDocs on Jitsi](https://meet.jit.si/AuxDocs) |
|
||||
| Core | Ad-hoc (calls for meetings posted to [forums](https://forum.aux.computer/c/special-interest-groups/sig-core/14) | around 1 hour | [AuxSigCore on Jitsi](https://meet.jit.si/AuxSigCore) |
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Code Standards
|
||||
description: Standards for code in Aux
|
||||
published: true
|
||||
date: 2024-07-01T19:25:35.789Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-16T22:18:45.623Z
|
||||
|
|
@ -13,14 +13,15 @@ dateCreated: 2024-05-16T22:18:45.623Z
|
|||
When writing files which contribute to the Aux project, you should use [our standard formatting and linting tools for your language](/contributing/formatting/tools). If there is not a tool designated on that page, you should use the tool which is most commonly used for your language and add it to [our standard formatting and linting tools page](/contributing/formatting/tools).
|
||||
|
||||
> If your formatter or linter in default configuration disagrees with anything on this page, follow your formatter or linter. Ignore whatever guideline or guidelines on this page your linter has a differing default on.
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
> You should not configure your tools to accept the behavior on this page if they do not by default.
|
||||
{.is-danger}
|
||||
> {.is-danger}
|
||||
|
||||
# Naming
|
||||
|
||||
If your formatter or linter does not specify which naming convention to use please follow:
|
||||
|
||||
- **Classes, interfaces, and other types should use `UpperCamelCase`**
|
||||
- **Everything else, including functions and variables should use `lowerCamelCase`**
|
||||
|
||||
|
|
|
|||
|
|
@ -2,14 +2,16 @@
|
|||
title: Editorconfig
|
||||
description: Using .editorconfig
|
||||
published: true
|
||||
date: 2024-08-02T19:54:32.003Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-05T18:30:37.455Z
|
||||
---
|
||||
|
||||
# Global
|
||||
|
||||
Start your `.editorconfig` file with this:
|
||||
|
||||
```editorconfig
|
||||
root = true
|
||||
|
||||
|
|
@ -23,7 +25,7 @@ indent_style = tabs
|
|||
|
||||
> The formatting tool `prettier` adjust auto-formatting styles according to `.editorconfig` but ignores some attributes. This includes `insert_final_newline` which is hard-coded to `true`. See [prettier issue #6360](https://github.com/prettier/prettier/issues/6360#issuecomment-520368783)
|
||||
> Please ensure you are not setting `insert_final_newline` in any of your language specific settings.
|
||||
>{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
And add any additional types you need from below, making sure to separate each section with a new line.
|
||||
|
||||
|
|
@ -32,7 +34,9 @@ And add any additional types you need from below, making sure to separate each s
|
|||
# Programming Languages
|
||||
|
||||
## Nix
|
||||
|
||||
Using nixfmt-rfc-style
|
||||
|
||||
```editorconfig
|
||||
[*.nix]
|
||||
indent_size = 2
|
||||
|
|
@ -40,7 +44,9 @@ indent_style = space
|
|||
```
|
||||
|
||||
## Python
|
||||
|
||||
Using pycodestyle
|
||||
|
||||
```editorconfig
|
||||
[*.{py,py3}]
|
||||
indent_size = 4
|
||||
|
|
@ -48,27 +54,34 @@ indent_style = space
|
|||
```
|
||||
|
||||
## Node.js
|
||||
|
||||
Using prettier
|
||||
|
||||
```editorconfig
|
||||
[*.{cjs,mjs,js,ts,jsx,tsx}]
|
||||
indent_size = 2
|
||||
```
|
||||
|
||||
## Rust
|
||||
|
||||
Using cargo fmt
|
||||
|
||||
```editorconfig
|
||||
[*.rs,Cargo.toml]
|
||||
indent_size = 4
|
||||
```
|
||||
|
||||
## Go
|
||||
|
||||
Using gofmt
|
||||
|
||||
```editorconfig
|
||||
[*.{go,mod}]
|
||||
indent_size = 4
|
||||
```
|
||||
|
||||
## C and Related
|
||||
|
||||
```editorconfig
|
||||
[*.{c,cpp,cs,h,hpp,C,H,cxx,hxx}]
|
||||
indent_size = 4
|
||||
|
|
@ -78,6 +91,7 @@ indent_size = 2
|
|||
```
|
||||
|
||||
## Shell Script
|
||||
|
||||
```editorconfig
|
||||
[*.{sh,zsh,bash,bat,cmd,ps1,psm1}]
|
||||
indent_size = 4
|
||||
|
|
@ -86,6 +100,7 @@ indent_size = 4
|
|||
# Markup Languages
|
||||
|
||||
## Markdown
|
||||
|
||||
```editorconfig
|
||||
[*.md]
|
||||
indent_size = 2
|
||||
|
|
@ -93,6 +108,7 @@ trim_trailing_whitespace = false
|
|||
```
|
||||
|
||||
## Web
|
||||
|
||||
```editorconfig
|
||||
[*.{htm,html,less,svg,vue}]
|
||||
indent_size = 2
|
||||
|
|
@ -104,12 +120,14 @@ indent_size = 2
|
|||
# Data Storage Files
|
||||
|
||||
## JSON, YAML
|
||||
|
||||
```editorconfig
|
||||
[*.{json,json5,webmanifest}]
|
||||
indent_size = 2
|
||||
```
|
||||
|
||||
## YAML
|
||||
|
||||
```editorconfig
|
||||
[*.{yaml,yml}]
|
||||
indent_style = space
|
||||
|
|
@ -117,6 +135,7 @@ indent_size = 2
|
|||
```
|
||||
|
||||
## TOML
|
||||
|
||||
```editorconfig
|
||||
[*.toml]
|
||||
indent_style = unset
|
||||
|
|
@ -124,12 +143,14 @@ indent_size = 0
|
|||
```
|
||||
|
||||
## \*RC
|
||||
|
||||
```editorconfig
|
||||
[.*rc]
|
||||
indent_size = 2
|
||||
```
|
||||
|
||||
## CSV
|
||||
|
||||
```editorconfig
|
||||
[*.csv]
|
||||
end_of_line = unset
|
||||
|
|
@ -140,6 +161,7 @@ indent_style = unset
|
|||
```
|
||||
|
||||
## Lockfile
|
||||
|
||||
```editorconfig
|
||||
[*.lock]
|
||||
indent_style = unset
|
||||
|
|
@ -147,6 +169,7 @@ insert_final_newline = unset
|
|||
```
|
||||
|
||||
## Git
|
||||
|
||||
```editorconfig
|
||||
[*.{diff,patch}]
|
||||
end_of_line = unset
|
||||
|
|
@ -161,6 +184,7 @@ indent_size = 0
|
|||
```
|
||||
|
||||
## Keys
|
||||
|
||||
```editorconfig
|
||||
[*.{asc,key,ovpn,pem}]
|
||||
end_of_line = unset
|
||||
|
|
|
|||
|
|
@ -2,19 +2,22 @@
|
|||
title: Project Standards
|
||||
description: Code-related standards in Aux
|
||||
published: true
|
||||
date: 2024-07-01T19:26:20.836Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-05T21:22:30.441Z
|
||||
---
|
||||
|
||||
# Naming
|
||||
|
||||
All non-code names, including but not limited to CI Actions, Respositories, and folder and file names inside the project, must follow lower-kebab-case except in cases where a program requires something else.
|
||||
|
||||
Names for variables, classes, etc. in code should instead follow our [code formatting standards](/contributing/formatting/code), which are generally that types should be `UpperCamelCase`, and other variables should be `lowerCamelCase`.
|
||||
|
||||
# Structure
|
||||
|
||||
All projects should provide:
|
||||
|
||||
- A devenv when applicable, preferably in the form of direnv.
|
||||
- If devenv is applicable also provide a flake.lock
|
||||
- A short summary of what the project does, as well as how to use the project in a top level README.md
|
||||
|
|
@ -23,6 +26,7 @@ All projects should provide:
|
|||
- A top level LICENSE file or folder of which includes the License or Licenses used in the project
|
||||
|
||||
# Commit Messages
|
||||
|
||||
- First line of the commit message should be a short (<50 chars) description of the purpose of the commit
|
||||
- First word should be one of: `feat:` for feature, `fix:` for bugfixes, or `break:` for breaking changes
|
||||
- First line and main message should have 1 blank newline in between them for ease of reading
|
||||
|
|
@ -32,7 +36,9 @@ All projects should provide:
|
|||
- **Breaking Changes** should have what it breaks, how it breaks it, and a short transition guide
|
||||
|
||||
# Merging to main with bugs
|
||||
|
||||
There are a few reasonable expectations for merges, one is that any change that is made in the project should not include bugs except in extremely rare cases where bugs are unable to be fixed without upstream changes. In this case a bug should be added to the projects kanban board (or similar) with relevant information like the file & code section the bug is in and which upstream issue is causing the bug (if known).
|
||||
|
||||
# Code
|
||||
|
||||
Autoformat specifications for code can be found on our [Editorconfig standards](https://wiki.auxolotl.org/contributing/formatting/editorconfig) page. Please check them there.
|
||||
|
|
@ -2,17 +2,18 @@
|
|||
title: Formatting tools
|
||||
description: How to format code in Aux
|
||||
published: true
|
||||
date: 2024-08-02T02:13:44.468Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-19T12:41:51.196Z
|
||||
---
|
||||
|
||||
# Formatting tools
|
||||
|
||||
Please use the standard formatting tools for your language, and obey them over all Aux formatting guidelines. If there are no listed formatting tools, you should use the tool which is most commonly used for your language and add it to this page.
|
||||
|
||||
> You should not configure your formatter, you should instead use its default options
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
## Using treefmt
|
||||
|
||||
|
|
@ -29,12 +30,14 @@ For Nix, use [`pkgs.nixfmt-rfc-style`](https://search.nixos.org/packages?channel
|
|||
`nixfmt-rfc-style` is based on [`nixfmt`](https://github.com/nixos/nixfmt), however its style differs significantly from the original nixfmt, as its style is based on [NixOS RFC 166](https://github.com/NixOS/rfcs/pull/166). Please don't use the original `nixfmt` style.
|
||||
|
||||
#### Using nixfmt {.tabset}
|
||||
|
||||
##### With flakes
|
||||
|
||||
If you're using flakes, you can set your nix formatter in your `flake.nix` outputs.
|
||||
|
||||
> For nixpkgs release earlier than `24.05`, `nixfmt-rfc-style` is unavailable, so you may need to introduce an unstable nixpkgs input if you do not already have one.
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs = {
|
||||
|
|
@ -46,12 +49,15 @@ If you're using flakes, you can set your nix formatter in your `flake.nix` outpu
|
|||
};
|
||||
}
|
||||
```
|
||||
|
||||
...and then use the formatter by running `nix fmt`
|
||||
|
||||
```bash
|
||||
$ nix fmt
|
||||
```
|
||||
|
||||
If you're using `direnv`, you may get an error like this
|
||||
|
||||
```
|
||||
nixfmt: ./.direnv/flake-inputs/99iafi55mrsflh7agb1aqvgcdxraa612-source: openTempFileWithDefaultPermissions: permission denied (Read-only file system)
|
||||
```
|
||||
|
|
@ -65,7 +71,7 @@ $ nix fmt **/*.nix
|
|||
##### With nix-shell
|
||||
|
||||
> For nixpkgs release earlier than `24.05`, `nixfmt-rfc-style` is unavailable, you must use an unstable channel.
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
```
|
||||
$ nix-shell -p nixfmt-rfc-style
|
||||
|
|
@ -80,7 +86,7 @@ $ nixfmt **/*.nix
|
|||
##### With nix shell
|
||||
|
||||
> For nixpkgs release earlier than `24.05`, `nixfmt-rfc-style` is unavailable, you must use an unstable channel.
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
```
|
||||
$ nix shell github:nixos/nixpkgs#nixfmt-rfc-style
|
||||
|
|
@ -93,12 +99,13 @@ $ nixfmt **/*.nix
|
|||
```
|
||||
|
||||
### JavaScript, TypeScript, Markdown
|
||||
|
||||
For JavaScript, TypeScript or Markdown, use [**Prettier**](https://prettier.io/).
|
||||
|
||||
For more details, you can refer to [the prettier installation guide](https://prettier.io/docs/en/install).
|
||||
|
||||
### Python
|
||||
|
||||
For Python, use [**Black**](https://black.readthedocs.io/en/stable/).
|
||||
|
||||
# Linting tools
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Matrix
|
||||
description: Join our Matrix chat channels
|
||||
published: true
|
||||
date: 2024-05-15T22:14:38.530Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-06T23:45:41.266Z
|
||||
|
|
@ -27,7 +27,7 @@ We also have [SIG-and-committee](/community)-specific channels.
|
|||
## For SIGs
|
||||
|
||||
| Name | Purpose | Link |
|
||||
| ------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| ---------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| SIG:Documentation General | Discuss our documentation or suggest and coordinate improvements | [#SIGDOCS-GEN:auxolotl.org](https://matrix.to/#/#SIGDOCS-GEN:auxolotl.org) |
|
||||
| SIG:JavaScript General | Discuss or ask for help with JavaScript support on Aux | [#SIGJS-GEN:auxolotl.org](https://matrix.to/#/#SIGJS-GEN:auxolotl.org) |
|
||||
| SIG:Python General | Discuss or ask for help with Python support on Aux | [#SIGPY-GEN:auxolotl.org](https://matrix.to/#/#SIGPY-GEN:auxolotl.org) |
|
||||
|
|
@ -56,7 +56,7 @@ We also have [SIG-and-committee](/community)-specific channels.
|
|||
## For Committees
|
||||
|
||||
| Name | Purpose | Link |
|
||||
|-----------------------------|------------------------------------------------------------------|----------------------------------------------------------------------------------|
|
||||
| ------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Committee: Steering General | Talk about large-scale project direction | [#COMSTEER-GEN:auxolotl.org](https://matrix.to/#/#COMSTEER-GEN:auxolotl.org) |
|
||||
| Committee: Security General | Talk about security and how we can make Aux reasonably secure | [#COMSEC-GEN:auxolotl.org](https://matrix.to/#/#COMSEC-GEN:auxolotl.org) |
|
||||
| Committee: Code of Conduct General | Public discussion and questions for the committee | [#COMCOC-GEN:auxolotl.org](https://matrix.to/#/#COMCOC-GEN:auxolotl.org) |
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Wiki Quickstart
|
||||
description: How to contribute to the Aux Wiki
|
||||
published: true
|
||||
date: 2024-08-02T21:17:22.931Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags: tutorial, quickstart
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-06T00:01:20.106Z
|
||||
|
|
@ -15,7 +15,7 @@ The Auxolotl wiki runs on [Wiki.js](https://js.wiki/), a powerful, extensible an
|
|||
It's recommended that you read the official documentation for Wiki.js before you proceed, notably the [Introduction to Wiki.js](https://docs.requarks.io/guide/intro) and [Folder Structure & Tags](https://docs.requarks.io/en/guide/structure) guides. However, we'll do the best we can to link to relevant sections.
|
||||
|
||||
> This is a work in progress. Please help improve the documentation
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
# Account
|
||||
|
||||
|
|
@ -44,10 +44,11 @@ When you create a new page, all you need to do is specify where it's going to li
|
|||
1. (Optional) Add [tags](#Tags) and a description
|
||||
1. Choose Markdown[^1] as editor and start writing
|
||||
1. (Optional) Add [assets](https://docs.requarks.io/en/guide/assets) by using the `Insert Assets` button on the left toolbar
|
||||
1. If you need to modify the page details _(path, tags, ...)_, click `PAGE` on the top bar
|
||||
1. If you need to modify the page details (_path_, _tags_, ...), click `PAGE` on the top bar
|
||||
1. Once you're satisfied with your changes, click on `CREATE`
|
||||
|
||||
<!-- multi-line foornote -->
|
||||
|
||||
[^1]:
|
||||
Conversion between `Markdown` and other editors might lead to a loss in formatting. That's why it's better to stick to one format. Currently, `Markdown` is the best choice since it's versatile and also easy to use.<br>
|
||||
More details can be found in the [Editors](https://docs.requarks.io/en/editors) guide.
|
||||
|
|
@ -70,7 +71,7 @@ When you create a new page, all you need to do is specify where it's going to li
|
|||
- `/docs/manual/unstable/install`
|
||||
|
||||
> There should be **no spaces in names** and **no slashes `'/'` at the end**
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
Since the `/contributing` path already exists, the `wiki` page will just be created under it.
|
||||
|
||||
|
|
@ -131,8 +132,8 @@ Note that we nested a page `quickstart` inside another page `wiki`. This is beca
|
|||
|
||||
Another way to think of it is that each folder has an initial **landing page** associated with it.
|
||||
|
||||
>If you wish to know more, you can read the [Folder Structure](https://docs.requarks.io/en/guide/structure#folder-structure) and [Nesting](https://docs.requarks.io/en/guide/structure#nesting) guides
|
||||
{.is-info}
|
||||
> If you wish to know more, you can read the [Folder Structure](https://docs.requarks.io/en/guide/structure#folder-structure) and [Nesting](https://docs.requarks.io/en/guide/structure#nesting) guides
|
||||
> {.is-info}
|
||||
|
||||
# Tags
|
||||
|
||||
|
|
@ -141,7 +142,7 @@ Tags can be used to easily and effectively categorize pages, which makes searchi
|
|||
When adding a new tag, you need to hit `Enter` on your keyboard for the tag to register. This means that tags can have spaces in their names. If a tag already exists, you will have the choice to select it.
|
||||
|
||||
> More details can be found in the [Tags](https://docs.requarks.io/en/guide/structure#tags) guide
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
After clicking on the `Browse by Tags` button next to the search bar, you will be presented with a screen that allows you to filter pages by one or more tags.
|
||||
|
||||
|
|
@ -181,16 +182,16 @@ Blockquotes can be stylized:
|
|||
> Have no color
|
||||
|
||||
> `{.is-info}`
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
> `{.is-success}`
|
||||
{.is-success}
|
||||
> {.is-success}
|
||||
|
||||
> `{.is-warning}`
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
> `{.is-danger}`
|
||||
{.is-danger}
|
||||
> {.is-danger}
|
||||
|
||||
## Multi-line footnotes
|
||||
|
||||
|
|
@ -202,6 +203,7 @@ Each new line should be tabbed. If you also want a newline inside the footnote,
|
|||
Second line<br>
|
||||
Third line
|
||||
```
|
||||
|
||||
You can see the result here[^2].
|
||||
|
||||
[^2]:
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Nix built-in and lib functions
|
||||
description: An overview of the various functions available in Nix and Nixpkgs lib.
|
||||
published: true
|
||||
date: 2024-06-29T14:32:32.688Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags: nix, nixpkgs
|
||||
editor: markdown
|
||||
dateCreated: 2024-06-09T16:32:18.232Z
|
||||
|
|
@ -17,74 +17,84 @@ This page is an overview of the Nix built-in functions, and functions available
|
|||
Built-ins are core language functions built directly into the Nix language evaluator. These functions are available through the global `builtins` constant.
|
||||
|
||||
Resources:
|
||||
* [Nix manual](https://nix.dev/manual/nix/2.22/language/builtins)
|
||||
* [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#nix-builtin-functions)
|
||||
|
||||
- [Nix manual](https://nix.dev/manual/nix/2.22/language/builtins)
|
||||
- [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#nix-builtin-functions)
|
||||
|
||||
## Assertion functions (`lib.asserts`)
|
||||
|
||||
Assertions are generally used to check and/or enforce certain requirements in your configuration files. They're often used to handle conflicts between features or dependencies.
|
||||
|
||||
Resources:
|
||||
* [Nix manual](https://nix.dev/manual/nix/2.22/language/constructs.html?highlight=assertion#assertions)
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/asserts.nix)
|
||||
|
||||
- [Nix manual](https://nix.dev/manual/nix/2.22/language/constructs.html?highlight=assertion#assertions)
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/asserts.nix)
|
||||
|
||||
## Attribute-set functions (`lib.attrset`)
|
||||
|
||||
Attribute sets are collections of name-value pairs (called _attributes_) enclosed in curly braces ( `{ }` )
|
||||
|
||||
Resources:
|
||||
* [Nix manual](https://nix.dev/manual/nix/2.22/language/values.html?highlight=attribute%20set#attribute-set)
|
||||
* [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#attribute-set-functions)
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/attrsets.nix)
|
||||
|
||||
- [Nix manual](https://nix.dev/manual/nix/2.22/language/values.html?highlight=attribute%20set#attribute-set)
|
||||
- [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#attribute-set-functions)
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/attrsets.nix)
|
||||
|
||||
## Customization functions (`lib.customization`)
|
||||
|
||||
Customization functions let you override derivations and packages.
|
||||
|
||||
Sources:
|
||||
* [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#customisation-functions)
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/customisation.nix)
|
||||
|
||||
- [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#customisation-functions)
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/customisation.nix)
|
||||
|
||||
## Debugging functions (`lib.debug`)
|
||||
|
||||
Debug functions are useful for debugging Nix expressions.
|
||||
* `trace`-like functions take two values, print the first to stderr and return the second.
|
||||
* `traceVal`-like functions take one argument which both printed and returned.
|
||||
* `traceSeq`-like functions fully evaluate their traced value before printing (not just to “weak head normal form” like trace does by default).
|
||||
* Functions that end in `-Fn` take an additional function as their first argument, which is applied to the traced value before it is printed.
|
||||
|
||||
- `trace`-like functions take two values, print the first to stderr and return the second.
|
||||
- `traceVal`-like functions take one argument which both printed and returned.
|
||||
- `traceSeq`-like functions fully evaluate their traced value before printing (not just to “weak head normal form” like trace does by default).
|
||||
- Functions that end in `-Fn` take an additional function as their first argument, which is applied to the traced value before it is printed.
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/debug.nix)
|
||||
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/debug.nix)
|
||||
|
||||
## Local Files (`lib.fileset`)
|
||||
|
||||
A safer and more convenient interface for working with local files (compared to nix's built-in functionality).
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/tree/master/lib/fileset)
|
||||
* [Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#sec-functions-library-fileset)
|
||||
* [nix.dev Tutorial](https://nix.dev/tutorials/working-with-local-files)
|
||||
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/tree/master/lib/fileset)
|
||||
- [Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#sec-functions-library-fileset)
|
||||
- [nix.dev Tutorial](https://nix.dev/tutorials/working-with-local-files)
|
||||
|
||||
## Generator functions (`lib.generators`)
|
||||
|
||||
Generators can create various file formats from Nix data structures. They all use a similar interface: `generator { config-attrs } data`. `config-attrs` are used to overwrite the generator's default attributes.
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/generators.nix)
|
||||
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/generators.nix)
|
||||
|
||||
## List manipulation functions (`lib.lists`)
|
||||
|
||||
List manipulation functions let you create and manipulate lists.
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/lists.nix)
|
||||
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/lists.nix)
|
||||
|
||||
## Meta functions (`lib.meta`)
|
||||
|
||||
Meta functions override metadata attributes about derivations, packages, attribute sets, and other Nix constructs.
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/meta.nix)
|
||||
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/meta.nix)
|
||||
|
||||
## Modules functions (`lib.modules`)
|
||||
|
||||
|
|
@ -92,17 +102,19 @@ Modules functions let you define, evaluate, and merge Nix modules. They also inc
|
|||
|
||||
Two of the most commonly used functions in this set are:
|
||||
|
||||
* `mkIf`, which lets you adds conditional statements to your modules, and
|
||||
* `mkMerge`, which lets you combine multiple module definitions into one.
|
||||
- `mkIf`, which lets you adds conditional statements to your modules, and
|
||||
- `mkMerge`, which lets you combine multiple module definitions into one.
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/modules.nix)
|
||||
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/modules.nix)
|
||||
|
||||
## NixOS / Nixpkgs option handling functions (`lib.options`)
|
||||
|
||||
Options are attributes commonly used to enable and configure Nix modules. Options are declared using the `mkOption` function.
|
||||
|
||||
Sources:
|
||||
|
||||
- [NixOS Wiki](https://nixos.wiki/wiki/Declaration)
|
||||
- [My NixOS](https://mynixos.com/help/nixos-options)
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/options.nix)
|
||||
|
|
@ -112,8 +124,9 @@ Sources:
|
|||
Source filtering functions change how sources are copied to the Nix store. For example, if you want to add a Git repository to your Nix store, but don't want to include the `.git` folder, you can use `lib.sources.cleanSource ./folder`.
|
||||
|
||||
Sources:
|
||||
* [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#source-filtering-functions)
|
||||
* [Nixpks source](https://github.com/NixOS/nixpkgs/blob/master/lib/sources.nix)
|
||||
|
||||
- [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#source-filtering-functions)
|
||||
- [Nixpks source](https://github.com/NixOS/nixpkgs/blob/master/lib/sources.nix)
|
||||
|
||||
## String manipulation functions (`lib.strings`)
|
||||
|
||||
|
|
@ -124,8 +137,9 @@ String manipulation functions are used to create, manipulate, and parse strings
|
|||
- Checking if a string is a certain type (`lib.isInt`, `lib.isPath`, etc.)
|
||||
|
||||
Sources:
|
||||
* [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#string-manipulation-functions)
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/strings.nix)
|
||||
|
||||
- [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#string-manipulation-functions)
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/strings.nix)
|
||||
|
||||
## Miscellaneous functions (`lib.trivial`)
|
||||
|
||||
|
|
@ -139,13 +153,15 @@ Miscellaneous functions are functions that don't fit under any other category. T
|
|||
- Error and exception-handling functions (`lib.trivial.warn`, `lib.trivial.throwIf`, etc.)
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#miscellaneous-functions)
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/trivial.nix)
|
||||
|
||||
- [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#miscellaneous-functions)
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/trivial.nix)
|
||||
|
||||
## Versions functions (`lib.versions`)
|
||||
|
||||
Versions functions are for parsing version numbers from a string. This works well in tandem with `lib.trivial.version`, which retrieves the current Nixpkgs version.
|
||||
|
||||
Resources:
|
||||
* [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#versions-functions)
|
||||
* [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/versions.nix)
|
||||
|
||||
- [Nixpkgs lib reference by teu5us](https://teu5us.github.io/nix-lib.html#versions-functions)
|
||||
- [Nixpkgs source](https://github.com/NixOS/nixpkgs/blob/master/lib/versions.nix)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Language/Framework Specific Builders in Nixpkgs
|
||||
description: How to use different languages or frameworks in Nixpkgs/Aux
|
||||
published: true
|
||||
date: 2024-07-01T19:28:46.515Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags: nix, nixpkgs
|
||||
editor: markdown
|
||||
dateCreated: 2024-06-22T15:04:51.666Z
|
||||
|
|
@ -37,4 +37,3 @@ Nixpkgs has various specialised alternatives to `mkDerivation`, such as `buildPy
|
|||
Resources:
|
||||
|
||||
- [Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#chap-language-support)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Nixpkgs Tools
|
||||
description: An overview of the various functions unrelated to building source code available in Nixpkgs.
|
||||
published: true
|
||||
date: 2024-06-29T14:50:41.540Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags: nix, nixpkgs
|
||||
editor: markdown
|
||||
dateCreated: 2024-06-22T16:41:59.925Z
|
||||
|
|
@ -74,7 +74,7 @@ Resources:
|
|||
|
||||
## `fakeNss`
|
||||
|
||||
Including this *derivation* in, e.g. docker images or other environments without them, provides a simplistic set of user/group entries, to allow binaries expecting them to exist to work.
|
||||
Including this _derivation_ in, e.g. docker images or other environments without them, provides a simplistic set of user/group entries, to allow binaries expecting them to exist to work.
|
||||
|
||||
Resources:
|
||||
|
||||
|
|
@ -107,7 +107,6 @@ Resources:
|
|||
- [nix.dev Tutorial: Building and running Docker images)](https://nix.dev/tutorials/nixos/building-and-running-docker-images.html)
|
||||
- [Xe Iaso's Blog Post: Nix Flakes: Packages and How to Use Them](https://xeiaso.net/blog/nix-flakes-2-2022-02-27/)
|
||||
|
||||
|
||||
## Build OCI Containers (`pkgs.ociTools`)
|
||||
|
||||
A set of function to create [OCI containers](https://github.com/opencontainers/runtime-spec/blob/v1.0.0/spec.md).
|
||||
|
|
|
|||
16
glossary.md
16
glossary.md
|
|
@ -2,7 +2,7 @@
|
|||
title: Glossary
|
||||
description: What does that thing mean?
|
||||
published: true
|
||||
date: 2024-05-28T22:37:17.924Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-20T22:45:48.273Z
|
||||
|
|
@ -15,28 +15,30 @@ Acronyms, shortenings and technical terms should appear in this glossary.
|
|||
If you know something that we've not mentioned, please add it!
|
||||
|
||||
> This glossary is alphabetically ordered, and different starting letters have a heading. Please keep that ordering when you add words so it remains easy to navigate.
|
||||
{.is-info}
|
||||
> {.is-info}
|
||||
|
||||
## C
|
||||
|
||||
| Word | Short for | Definition |
|
||||
| ---- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| COM | Committee | A group of people responsible for setting standards for a specific area throughout the project. For more information, see [our page on Committees](/community/committees) |
|
||||
| COMSEC | Security Committee | Our committee focused around security. See [the security community pages](/community/security) to learn more about them |
|
||||
|
||||
## L
|
||||
|
||||
| Word | Short for | Definition |
|
||||
| ---- | --------- | ---------- |
|
||||
| ---- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Lix | | A fork of the C++ implementation of Nix, and the preferred Nix implementation to use with Aux. You can visit [their website](https://lix.systems/) for more information, or see [our page on Lix](/lix) to see more things we've said about using them with Aux |
|
||||
|
||||
## S
|
||||
|
||||
| Word | Short for | Definition |
|
||||
| ---- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| ---- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| SIG | Special Interest Group | A group of people responsible for making projects and setting goals for specific areas of the project. For more information, see [our page on Special Interest Groups](/community/sigs) |
|
||||
|
||||
## W
|
||||
|
||||
| Word | Short for | Definition |
|
||||
| ---- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| ------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| WANCAIN | We Are Nice 'Cause Aux Is Nice | A principle to be nice and kind, because doing so will build the nice community that we are aspiring to be. See [this forum post if you're interested in the origin of this phrase](https://forum.aux.computer/t/how-to-behave-on-aux-wancain/324) |
|
||||
| WG | Working Group | Organized by Special Interest Groups, a temporary group for working on a specific project. May contain members from multiple special interest groups |
|
||||
|
||||
|
|
|
|||
2
home.md
2
home.md
|
|
@ -2,7 +2,7 @@
|
|||
title: Aux Wiki
|
||||
description: Welcome to the Aux wiki!
|
||||
published: true
|
||||
date: 2024-07-07T13:40:46.035Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-05T14:41:36.200Z
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Installation Guide
|
||||
description: A quick guide to getting started with installing and using Auxolotl.
|
||||
published: true
|
||||
date: 2024-05-16T21:38:03.976Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags: installation, tutorial
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-05T15:44:03.224Z
|
||||
|
|
|
|||
|
|
@ -2,15 +2,17 @@
|
|||
title: Migration Guide
|
||||
description: Migrating from Nix to Aux
|
||||
published: true
|
||||
date: 2024-05-16T21:36:30.357Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-16T21:27:55.828Z
|
||||
---
|
||||
|
||||
# Migration from Nix to Aux
|
||||
|
||||
> This page is a work in progress
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
## Lix
|
||||
|
||||
One of the things we're transferring out of is NixCPP, our chosen replacement is our lovely friends at [Lix](https://lix.systems). Feel free to check out their [Lix installation guide](https://lix.systems/install/) on their website.
|
||||
23
treefmt.nix
Normal file
23
treefmt.nix
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
_: {
|
||||
# Used to find the project root
|
||||
projectRootFile = "flake.nix";
|
||||
|
||||
# Files not to format.
|
||||
settings.global.excludes = [
|
||||
".editorconfig"
|
||||
"LICENSE"
|
||||
];
|
||||
|
||||
# nix
|
||||
programs.nixfmt.enable = true; # As of 2024-07-30 this is nixfmt-rfc-style.
|
||||
programs.statix.enable = true;
|
||||
programs.deadnix.enable = true;
|
||||
|
||||
# markdown
|
||||
programs.prettier = {
|
||||
enable = true;
|
||||
settings = {
|
||||
editorconfig = true;
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: Vision
|
||||
description: Our vision for Aux
|
||||
published: true
|
||||
date: 2024-07-01T19:13:42.308Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-24T19:33:34.890Z
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Communication
|
||||
description:
|
||||
published: true
|
||||
date: 2024-06-07T20:02:37.323Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-06-07T19:58:49.689Z
|
||||
|
|
@ -12,9 +12,12 @@ dateCreated: 2024-06-07T19:58:49.689Z
|
|||
> Please fill in all instances of [FILL_IN] with what they should be.
|
||||
> To find an example of a filled in page, please visit [SIG: Core](/community/core/communication)
|
||||
> After filling in all the spaces, please remove this warning
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
# Communication
|
||||
|
||||
[FILL_IN] has a few different ways we can communicate. You can use any of the following:
|
||||
|
||||
- Send a message to [[FILL_IN] - General on Matrix](https://matrix.to/#/#[FILL_IN]-GEN:auxolotl.org)
|
||||
- View and comment on ongoing topics in the [Discourse Category](https://forum.aux.computer/c/[FILL_IN])
|
||||
- TODO (EMAIL)
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: Onboarding
|
||||
description:
|
||||
published: true
|
||||
date: 2024-05-25T15:54:14.942Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-25T15:53:49.007Z
|
||||
|
|
@ -12,7 +12,8 @@ dateCreated: 2024-05-25T15:53:49.007Z
|
|||
> Please fill in all instances of [FILL_IN] with what they should be.
|
||||
> To find an example of a filled in page, please visit [SIG: Core](/community/core/onboarding)
|
||||
> After filling in all the spaces, please remove this warning
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
# Onboarding
|
||||
|
||||
If you are interested in joining [FILL_IN], please make sure to follow the steps listed below. For now all steps are manual, there's not yet automation or data-sync between different platforms in place. We hope to be able to change this in the future.
|
||||
|
|
@ -20,19 +21,24 @@ If you are interested in joining [FILL_IN], please make sure to follow the steps
|
|||
Should any of the links below be broken or descriptions inaccurate we highly appreciate a PR with corrections.
|
||||
|
||||
## Group memberships
|
||||
1) Request your membership to the [Discourse Group "[FILL_IN]"](https://forum.aux.computer/g/[FILL_IN]/)
|
||||
2) Request your membership to the [Github Team "[FILL_IN]"](https://github.com/orgs/auxolotl/teams/[FILL_IN])
|
||||
3) Add/ update your membership status in the [community repo](https://github.com/auxolotl/community)
|
||||
- Add or update your user settings in [`users.nix`](https://github.com/auxolotl/community/blob/main/users.nix)
|
||||
- Add your user to list `sigs.[FILL_IN].members` in [`memberships.nix`](https://github.com/auxolotl/community/blob/main/memberships.nix)
|
||||
- Create a PR to add yourself to the ["Team members" in the wiki]([FILL_IN]).
|
||||
|
||||
Make sure to stick with the alphabetic ordering for readability!
|
||||
1. Request your membership to the [Discourse Group "[FILL_IN]"](https://forum.aux.computer/g/[FILL_IN]/)
|
||||
2. Request your membership to the [Github Team "[FILL_IN]"](https://github.com/orgs/auxolotl/teams/[FILL_IN])
|
||||
3. Add/ update your membership status in the [community repo](https://github.com/auxolotl/community)
|
||||
|
||||
- Add or update your user settings in [`users.nix`](https://github.com/auxolotl/community/blob/main/users.nix)
|
||||
- Add your user to list `sigs.[FILL_IN].members` in [`memberships.nix`](https://github.com/auxolotl/community/blob/main/memberships.nix)
|
||||
- Create a PR to add yourself to the ["Team members" in the wiki]([FILL_IN]).
|
||||
|
||||
Make sure to stick with the alphabetic ordering for readability!
|
||||
|
||||
## Communication channels
|
||||
|
||||
Make sure you have joined the following channels on Matrix in which ad-hoc communication takes place
|
||||
|
||||
- [[FILL_IN] - Governance](https://matrix.to/#/#[FILL_IN]-GOV:auxolotl.org)
|
||||
- [[FILL_IN] - General](https://matrix.to/#/#[FILL_IN]-GEN:auxolotl.org)
|
||||
|
||||
## Meeting notes
|
||||
|
||||
Meeting notes are being archived and tagged in the forum, they can be accessed by filtering for the [meeting-minutes tag]([FILL_IN]).
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Welcome Page
|
||||
description:
|
||||
published: true
|
||||
date: 2024-05-31T20:04:47.962Z
|
||||
date: 2024-08-02T23:15:00.000Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2024-05-31T20:01:54.001Z
|
||||
|
|
@ -12,12 +12,14 @@ dateCreated: 2024-05-31T20:01:54.001Z
|
|||
> Please fill in all instances of [REPLACE_ME] with what they should be.
|
||||
> To find an example of a filled in page, please visit [SIG: Core](/community/core)
|
||||
> After filling in all the spaces, please remove this warning
|
||||
{.is-warning}
|
||||
> {.is-warning}
|
||||
|
||||
# Aux [REPLACE_ME]
|
||||
|
||||
## Welcome to the [REPLACE_ME]
|
||||
|
||||
These pages contain documentation specific to the [REPLACE_ME] regarding:
|
||||
|
||||
- [Onboarding/Joining]([REPLACE_ME])
|
||||
- Communication
|
||||
- Task Management
|
||||
|
|
|
|||
Loading…
Reference in a new issue