Skip to content

Commit

Permalink
Merge branch 'main' into move-son-blog
Browse files Browse the repository at this point in the history
  • Loading branch information
fricklerhandwerk authored Jan 30, 2025
2 parents cdcb7ff + aee8bdc commit 2c5d773
Show file tree
Hide file tree
Showing 14 changed files with 2,597 additions and 2,522 deletions.
61 changes: 54 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Source for nixos.org

[![CI](https://github.com/NixOS/nixos-homepage/actions/workflows/ci.yml/badge.svg)](https://github.com/NixOS/nixos-homepage/actions/workflows/ci.yml)
[![Number of open GitHub issues](https://img.shields.io/github/issues/nixos/nixos-homepage?style=flat&color=red)](https://github.com/nixos/nixos-homepage/issues)
[![Number of open GitHub pull requests](https://img.shields.io/github/issues-pr/nixos/nixos-homepage?style=flat&color=blue)](https://github.com/nixos/nixos-homepage/pulls)
Expand All @@ -7,19 +8,66 @@

Code and content for the [nixos.org](https://nixos.org) website.

# Contributing

Thank you for your interest in contributing to the NixOS homepage!
We value your time and effort in helping us improve this vital resource for the community.

We want to make contributing as simple and welcoming as possible while ensuring the sustainability of the project.
Our small team of volunteers prioritizes the [health and maintainability of the site over rushing features or catering to individual interests](https://github.com/NixOS/org/blob/main/doc/values.md).

Here’s how you can help us achieve that:

- Don’t hesitate to reach out! We’re here to guide you and get you started.
- If you feel lost on where or how to contribute, ask the [Marketing Team](https://nixos.org/community/teams/marketing.html) on the [`#marketing` room on Matrix](https://matrix.to/#/#marketing:nixos.org).
- Focus on contributions that align with the project's long-term goals and maintainable growth.
- Be mindful of the maintainers’ capacity. We, like you, are here because we are passionate about the project.

## Small Changes and Fixes

If you find a bug or need to make a small content change, feel free to submit a pull request.
There is no need to create an issue if the change is sufficiently small.
Here are a few examples:

- [An image was in the wrong location](https://github.com/NixOS/nixos-homepage/pull/1630)
- [Updating team members](https://github.com/NixOS/nixos-homepage/pull/1636)
- [Fixing the logic for asciinema-player](https://github.com/NixOS/nixos-homepage/pull/1597)

# Help us!
## All Work is Tracked in Issues

All work, whether proposed or in progress, should be documented in Issues.
This ensures transparency and makes it easier for anyone to pick up tasks or for maintainers to manage the workload.
There are many ways how you can help:

- if you are familiar with CSS look at the [issues tagged with `design` tag](https://github.com/NixOS/nixos-homepage/issues?q=is%3Aissue+is%3Aopen+label%3Adesign).
- if you are an native English speaker or just a person that is very good with words, please look at the [issues tagged with `content` tag](https://github.com/NixOS/nixos-homepage/issues?q=is%3Aissue+is%3Aopen+label%3Acontent)
- if you are developer and just eager to fix stuff please look at the [issues tagged with `bug` tag](https://github.com/NixOS/nixos-homepage/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
- If you are familiar with CSS look at the [issues tagged with `design` tag](https://github.com/NixOS/nixos-homepage/issues?q=is%3Aissue+is%3Aopen+label%3Adesign).
- If you are an native English speaker or just a person that is very good with words, please look at the [issues tagged with `content` tag](https://github.com/NixOS/nixos-homepage/issues?q=is%3Aissue+is%3Aopen+label%3Acontent)
- If you are developer and just eager to fix stuff please look at the [issues tagged with `bug` tag](https://github.com/NixOS/nixos-homepage/issues?q=is%3Aissue+is%3Aopen+label%3Abug)

If you feel lost where and how to contribute, ask the [marketing team](https://nixos.org/community/teams/marketing.html) on the [`#marketing` room on Matrix](https://matrix.to/#/#marketing:nixos.org).
## Propose Changes in the Right Place

It takes a lot of time and effort to keep the website running smoothly.
If you want to submit a change that is not tracked by an issue, propose it first so the details and scope can be refined before you start working.

# How to help?
- For well-scoped ideas that you can implement, check if their is an existing issue. If not, create one.
- For loosely defined ideas or if you lack the technical means to implement them, start a discussion in the Discussions section to refine the idea collaboratively.

## Separate Pull Requests by Type

When submitting pull requests, ensure they are categorized as one of the following:

- Design changes
- Content changes
- Technical changes

Avoid combining these types in a single pull request to make the review process smoother and more efficient.

Make sure to add a description in your pull request.
A few words can help reviewers understand your intent.
For example, if you are making design changes, you might want to answer why your changes are an improvement.
Similarly, if you are making technical changes, you might want answer how your changes work.
Add enough detail so we know what you know.

# Development

To run local development instance follow this steps to start a local server

Expand Down Expand Up @@ -64,7 +112,6 @@ substituters = ... https://nixos-homepage.cachix.org
trusted-public-keys = ... nixos-homepage.cachix.org-1:NHKBt7NjLcWfgkX4OR72q7LVldKJe/JOsfIWFDAn/tE=
```


## License

The content of the website is licensed under the [Creative Commons Attribution Share Alike 4.0 International](LICENSES/CC-BY-SA-4.0.txt) license.
Expand Down
27 changes: 15 additions & 12 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,24 @@ import icon from "astro-icon";
// theme derivated from https://raw.githubusercontent.com/shikijs/textmate-grammars-themes/main/packages/tm-themes/themes/vesper.json
import syntaxTheme from "./src/lib/shiki/theme.json";

import favicons from "astro-favicons";

// https://astro.build/config
export default defineConfig({
output: "static",
site: "https://nixos.org",
integrations: [
tailwind(),
mdx(),
sitemap(),
icon({
include: {
mdi: ["*"],
simpleIcons: ["*"],
},
}),
],
integrations: [tailwind(), mdx(), sitemap(), icon({
include: {
mdi: ["*"],
simpleIcons: ["*"],
},
}), favicons({
name: "Nix & NixOS",
short_name: "Nix & NixOS",
manifest: {
start_url: "/",
}
})],
legacy: {
collections: true, // TODO: migrate to Content Layer API
},
Expand All @@ -32,4 +35,4 @@ export default defineConfig({
},
},
compressHTML: true,
});
});
42 changes: 21 additions & 21 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2c5d773

Please sign in to comment.