status-badge

Free Your Tech Documentation

This repository contains the documentation for Free Your Tech, built with mdBook. It serves as a knowledge base about the organization and general technology topics. It can be used as a wiki that is editable via pull requests.

Structure

The documentation is organized into the following structure:

• src/: Contains all the documentation content in Markdown format
  • SUMMARY.md: Table of contents that defines the structure
  • introduction.md: Main landing page introducing the documentation
  • organization/: Information about setting up and running an organization like Free Your Tech
    • overview.md: Introduction to the organization setup section
    • Other pages covering specific aspects of organization setup
  • guides/: Technical guides for enhancing digital freedom and privacy
    • overview.md: Introduction to the technical guides section
    • Other pages covering specific technical topics

Contributing

We welcome contributions! This project is hosted on Codeberg and follows a forking workflow:

1. Fork the repository on Codeberg (you need to have a Codeberg account to do this),
2. Create a new branch for your changes,
3. Add your changes and test it locally,
4. Commit and push your changes,
5. Open a Pull Request on Codeberg from your fork to our main repository

We will review your changes in the pull request, give you feedback if anything needs to be changed, merge it into our main branch once it's ready. Once the changes are merged in, the CI system will automatically deploy the updates to the website.

Guidelines

• If you want to make big changes, open an issue first to discuss it
• Follow the existing code style and formatting
• Update documentation as needed
• Test your changes locally before submitting
• Keep PRs focused and self-contained

Prerequisites (without Nix)

• mdBook - for testing
• npins - for pinning Nix dependencies
• git - for version control

Installing mdBook can be cumbersome if it's not packaged for your system and you don't already have Rust and Cargo installed

Nix - Optional but recommended

We use a Nix-based shell environment, which can automatically download project dependencies and set up commands and environment variables. This way you don't have to manually install mdBook, git, or anything else, except for Nix.

If you don't already have Nix on your system, install Lix - a Nix implementation. It generally works on any Linux distribution, macOS, and Windows via WSL. Installation from your terminal:

curl -sSf -L https://install.lix.systems/lix | sh -s -- install

The installer asks if you want to enable Flakes, it doesn't matter for our use case.

Afterwards, run this command from this project's root directory to activate the shell environment:

nix-shell

This will make the dependencies available in your shell environment without any manual installation required.

See shell configuration in devenv.nix.

Local Development

1. Use git to clone the repository
2. Start local webserver with automatic hot reload:

   serve
   

3. Open http://localhost:3000/ in your browser, as instructed in the terminal
4. Add your changes and see it update live

Continuous Integration

This repository uses Woodpecker CI for continuous integration. The configuration is in .woodpecker.yml.

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.