refactor more prose

This commit is contained in:
marshmallow 2024-05-04 06:58:37 +10:00
parent 9f6a8cc98b
commit 7b72189f13
5 changed files with 89 additions and 80 deletions

View file

@ -1,4 +1,11 @@
{ {
"root.title": "aux.computer",
"root.description": "An alternative to the Nix ecosystem",
"header.community": "Community",
"header.Github": "Github",
"goals.title": "Goals",
"goals.independent.title": "Independent", "goals.independent.title": "Independent",
"goals.independent": "We will fork and maintain Nix, NixPkgs, and NixOS. Additional support for projects such as Nix Darwin and Home Manager will be considered.", "goals.independent": "We will fork and maintain Nix, NixPkgs, and NixOS. Additional support for projects such as Nix Darwin and Home Manager will be considered.",
"goals.gov.title": "Governance", "goals.gov.title": "Governance",
@ -8,5 +15,37 @@
"goals.infa.title": "Infastructure", "goals.infa.title": "Infastructure",
"goals.infa": "We will build and maintain the tools and infrastructure necessary to keep the ecosystem healthy, including Continuous Integration and Binary Caching.", "goals.infa": "We will build and maintain the tools and infrastructure necessary to keep the ecosystem healthy, including Continuous Integration and Binary Caching.",
"goals.education.title": "Education", "goals.education.title": "Education",
"goals.education": "Unified documentation, tutorials, guides, and examples will provide a better onboarding experience for newcomers and a faster iteration cycle for experts." "goals.education": "Unified documentation, tutorials, guides, and examples will provide a better onboarding experience for newcomers and a faster iteration cycle for experts.",
"roadmap.title": "Roadmap",
"roadmap.soft_fork.title": "Soft Fork",
"roadmap.soft_fork.1": "This initial phase will involve an ad-hoc management structure due to its bootstrapping nature. As such, the project's stated Values, Goals, and Roadmap serve to keep all contributors aligned and safe knowing that the work they have committed to will not change.",
"roadmap.soft_fork.2": "The initial forking off of Nix and NixPkgs will be performed in this phase and new contributors will be given roles for handling package maintenance and pulling changes from upstream. We intend to move on from this phase once enough contributors have joined for the project to be capable of transitioning into a hard fork.",
"roadmap.hard_fork.title": "Hard Fork",
"roadmap.hard_fork.1": "Like the Soft Fork phase, management structure will still be ad-hoc, but Committees, Special Interest Groups, and Working Groups may start to be formed. Due to there being necessary bootstrapping steps for each, elections will only begin once the Alignment phase has been reached.",
"roadmap.hard_fork.2": "At this point we will have enough contributors to safely maintain NixPkgs (or a reasonable subset) and Nix ourselves. We will begin allowing divergence from the upstream repository and changes to the repository structure to improve development can be introduced.",
"roadmap.hard_fork.3": "An initial release of the packages repository will be created and migration from `nix` to `aux` naming will begin to reduce confusion and errors now that the two projects have diverged.",
"roadmap.organization.title": "Organization",
"roadmap.organization.1": "The packages repository will have sets extracted to allow for Special Interest Groups to more easily manage their lifecycles. For example, `pythonPackages` will be moved to a separate repository that will be the reponsibility of a Python SIG if there is interest.",
"roadmap.organization.2": "Flakes will be standardized with its current implementation as a v0. While not ideal, the feature is used far too widely to be changed or removed without breaking the ecosystem. Instead, this v0 implementation will be enabled and future work for Flakes that addresses its shortcomings may be handled by a Flakes SIG.",
"roadmap.organization.3": "The `aux` CLI will be modified to provide more ergonomic management of packages and systems. Additional subcommands such as `aux system switch` and `aux system build` will be added to make onboarding and ongoing maintenance easier.",
"roadmap.infa.title": "Infastructure",
"roadmap.infa.1": "Now that the project has significantly diverged from upstream, we will need to provide our own Continuous Integration and Binary Cache services. Existing governance structures will be used to manage the adoption of these technologies.",
"roadmap.infa.2": "Documentation will be included as a part of the Continuous Integration process and will have Continuous Deployment configured to keep it up to date, making it easier for contributors to create educational materials.",
"roadmap.infa.3": "Search infrastructure for packages and options will also be created.",
"roadmap.alignment.title": "Alignment",
"roadmap.alignment.1": "By this point, we've done it. We have created a sustainable, independent fork of the Nix ecosystem. Now that the initial work has been completed we will begin the governance rotation process with our first elections and education as to how project governance works.",
"roadmap.alignment.2": "Documentation, project branding, and packages will be polished and presented as a fully stable release. From this point forward the Steering Committee will be managing the creation of Special Interest Groups and other necessary Committees. All enhancements will be suggested in Aux Enhancement Proposals which encourage existing SIGs to implement features or encourage the formation of a new SIG to be created for such a purpose.",
"values.title": "Values",
"values.rep.title": "Representation",
"values.rep": "Contributors should have their views represented and organizational structure should be established democratically.",
"values.kindness.title": "Kindness",
"values.kindness": "The project should be welcoming and a safe place for people to participate.",
"values.collab.title": "Collaboration",
"values.collab": "Communication and cooperation should be encouraged.",
"values.sustainability.title": "Sustainability",
"values.sustainability": "Workload, finance, scope, and burnout should all be considered carefully to ensure that the project is stable.",
"values.accessibility.title": "Accessibility",
"values.accessibility": "Elitism is unwelcome, our knowledge is here to be shared and we should provide the tools to help everyone succeed and learn."
} }

View file

@ -1,12 +1,17 @@
--- ---
interface Props {} interface Props {}
import { getLangFromUrl, useTranslations } from '../i18n/utils';
const lang = getLangFromUrl(Astro.url);
const t = useTranslations(lang);
--- ---
<header> <header>
<div class="left"> <div class="left">
<a href="https://aux.computer" class="brand"> <a href="https://aux.computer" class="brand">
<img class="icon" src="/aux.svg" /> <img class="icon" src="/aux.svg" />
<span class="title">aux.computer</span> <span class="title">{t("root.title")}</span>
</a> </a>
</div> </div>
<div class="right"> <div class="right">
@ -16,8 +21,8 @@ interface Props {}
<li><a href="https://aux.computer/documentation">Documentation</a></li> <li><a href="https://aux.computer/documentation">Documentation</a></li>
<li><a href="https://aux.computer/contribute">Contribute</a></li> <li><a href="https://aux.computer/contribute">Contribute</a></li>
--> -->
<li><a href="https://forum.aux.computer">Community</a></li> <li><a href="https://forum.aux.computer">{t("header.community")}</a></li>
<li><a href="https://github.com/auxolotl">Github</a></li> <li><a href="https://github.com/auxolotl">{t("header.github")}</a></li>
</ul> </ul>
</nav> </nav>
</div> </div>

View file

@ -1,5 +1,8 @@
--- ---
import { getLangFromUrl, useTranslations } from '../i18n/utils';
const lang = getLangFromUrl(Astro.url);
const t = useTranslations(lang);
--- ---
<div class="hero"> <div class="hero">
@ -7,8 +10,8 @@
<div class="icon"> <div class="icon">
<img src="/aux.svg" alt="" /> <img src="/aux.svg" alt="" />
</div> </div>
<h1 class="title">aux.computer</h1> <h1 class="title">{t("root.title")}</h1>
<div class="description">An alternative to the Nix ecosystem</div> <div class="description">{t("root.description")}</div>
</div> </div>
</div> </div>

View file

@ -1,102 +1,65 @@
--- ---
import { getLangFromUrl, useTranslations } from '../i18n/utils';
const lang = getLangFromUrl(Astro.url);
const t = useTranslations(lang);
--- ---
<section id="roadmap"> <section id="roadmap">
<h2>Roadmap</h2> <h2>{t("roadmap.title")}</h2>
<ol> <ol>
<li> <li>
<h3>Soft Fork</h3> <h3>{t("roadmap.soft_fork.title")}</h3>
<p> <p>
This initial phase will involve an ad-hoc management structure due to {t("roadmap.soft_fork.1")}
its bootstrapping nature. As such, the project's stated Values, Goals,
and Roadmap serve to keep all contributors aligned and safe knowing that
the work they have committed to will not change.
</p>
<p> <p>
The initial forking off of Nix and NixPkgs will be performed in this {t("roadmap.soft_fork.2")}
phase and new contributors will be given roles for handling package
maintenance and pulling changes from upstream. We intend to move on from
this phase once enough contributors have joined for the project to be
capable of transitioning into a hard fork.
</p> </p>
</li> </li>
<li> <li>
<h3>Hard Fork</h3> <h3>{t("roadmap.hard_fork.title")}</h3>
<p> <p>
Like the Soft Fork phase, management structure will still be ad-hoc, but {t("roadmap.hard_fork.1")}
Committees, Special Interest Groups, and Working Groups may start to be
formed. Due to there being necessary bootstrapping steps for each,
elections will only begin once the Alignment phase has been reached.
</p> </p>
<p> <p>
At this point we will have enough contributors to safely maintain {t("roadmap.hard_fork.2")}
NixPkgs (or a reasonable subset) and Nix ourselves. We will begin
allowing divergence from the upstream repository and changes to the
repository structure to improve development can be introduced.
</p> </p>
<p> <p>
An initial release of the packages repository will be created and {t("roadmap.hard_fork.3")}
migration from `nix` to `aux` naming will begin to reduce confusion and
errors now that the two projects have diverged.
</p> </p>
</li> </li>
<li> <li>
<h3>Organization</h3> <h3>{t("roadmap.organization.title")}</h3>
<p> <p>
The packages repository will have sets extracted to allow for Special {t("roadmap.organization.1")}
Interest Groups to more easily manage their lifecycles. For example,
`pythonPackages` will be moved to a separate repository that will be the
reponsibility of a Python SIG if there is interest.
</p> </p>
<p> <p>
Flakes will be standardized with its current implementation as a v0. {t("roadmap.organization.2")}
While not ideal, the feature is used far too widely to be changed or
removed without breaking the ecosystem. Instead, this v0 implementation
will be enabled and future work for Flakes that addresses its
shortcomings may be handled by a Flakes SIG.
</p> </p>
<p> <p>
The `aux` CLI will be modified to provide more ergonomic management of {t("roadmap.organization.3")}
packages and systems. Additional subcommands such as `aux system switch`
and `aux system build` will be added to make onboarding and ongoing
maintenance easier.
</p> </p>
</li> </li>
<li> <li>
<h3>Infrastructure</h3> <h3>{t("roadmap.infa.title")}</h3>
<p> <p>
Now that the project has significantly diverged from upstream, we will {t("roadmap.infa.1")}
need to provide our own Continuous Integration and Binary Cache
services. Existing governance structures will be used to manage the
adoption of these technologies.
</p> </p>
<p> <p>
Documentation will be included as a part of the Continuous Integration {t("roadmap.infa.2")}
process and will have Continuous Deployment configured to keep it up to
date, making it easier for contributors to create educational materials.
</p> </p>
<p> <p>
Search infrastructure for packages and options will also be created. {t("roadmap.infa.3")}
</p> </p>
</li> </li>
<li> <li>
<h3>Alignment</h3> <h3>{t("roadmap.alignment.title")}</h3>
<p> <p>
By this point, we've done it. We have created a sustainable, independent {t("roadmap.alignment.1")}
fork of the Nix ecosystem. Now that the initial work has been completed
we will begin the governance rotation process with our first elections
and education as to how project governance works.
</p> </p>
<p> <p>
Documentation, project branding, and packages will be polished and {t("roadmap.alignment.2")}
presented as a fully stable release. From this point forward the
Steering Committee will be managing the creation of Special Interest
Groups and other necessary Committees. All enhancements will be
suggested in Aux Enhancement Proposals which encourage existing SIGs to
implement features or encourage the formation of a new SIG to be created
for such a purpose.
</p> </p>
</li> </li>
</ol> </ol>

View file

@ -1,32 +1,31 @@
--- ---
import { getLangFromUrl, useTranslations } from '../i18n/utils';
const lang = getLangFromUrl(Astro.url);
const t = useTranslations(lang);
--- ---
<section id="values"> <section id="values">
<h2 class="title">Values</h2> <h2>{t("values.title")}</h2>
<h3 class="name">Representation</h3> <h3 class="name">{t("values.rep.title")}</h3>
<p class="description"> <p class="description">
Contributors should have their views represented and organizational {t("values.rep")}
structure should be established democratically.
</p> </p>
<h3 class="name">Kindness</h3> <h3 class="name">{t("values.kindness.title")}</h3>
<p class="description"> <p class="description">
The project should be welcoming and a safe place for people to {t("values.kindness")}
participate.
</p> </p>
<h3 class="name">Collaboration</h3> <h3 class="name">{t("values.collaboration.title")}</h3>
<p class="description"> <p class="description">
Communication and cooperation should be encouraged. {t("values.collaboration")}
</p> </p>
<h3 class="name">Sustainability</h3> <h3 class="name">{t("values.sustainability.title")}</h3>
<p class="description"> <p class="description">
Workload, finance, scope, and burnout should all be considered carefully {t("values.sustainability")}
to ensure that the project is stable.
</p> </p>
<h3 class="name">Accessibility</h3> <h3 class="name">{t("values.accessibility.title")}</h3>
<p class="description"> <p class="description">
Elitism is unwelcome, our knowledge is here to be shared and we should {t("values.accessibility")}
provide the tools to help everyone succeed and learn.
</p> </p>
</section> </section>