Skip to content

Commit

Permalink
docs: URL fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
htngr committed Dec 9, 2024
1 parent d26f27a commit 8895e89
Show file tree
Hide file tree
Showing 15 changed files with 95 additions and 194 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,23 @@ Codchi is a tool that manages your project's development environment in a reprod
## Getting Started

Read [What is Codchi?](https://codchi.dev/docs/start/intro.html) for an introduction to Codchi, or directly go to [Installation](https://codchi.dev/docs/start/installation.html).
Read [What is Codchi?](https://codchi.dev/introduction/what-is-codchi) for an introduction to Codchi, or directly go to [Installation](https://codchi.dev/introduction/installation).

## Contributing

Make sure to read [Internals](https://codchi.dev/docs/contrib/internals.html) to understand how Codchi works under the hood.
Make sure to read [Internals](https://codchi.dev/contrib/internals) to understand how Codchi works under the hood.

## Support

Codchi is a fully open-source project building on open foundations like NixOS modules. There is no vendor lock-in or open-core model. Codchi is funded through its use at aformatik as well as through professional support, training, and consulting services.
Codchi is a fully open source project built on open foundations such as NixOS modules. We actively avoid vendor lock-in. Codchi is financed by its use at aformatik as well as by professional support, training and consulting services.

### Community Support

For community support, we encourage users to engage through our GitHub page:

- **Feature Requests & Issues**: Report bugs, suggest new features, or ask questions via [GitHub Issues](https://github.com/aformatik/codchi/issues).
Report bugs, suggest new features, or ask questions via [GitHub Issues](https://github.com/aformatik/codchi/issues).

### Professional Support

For professional support, please contact [aformatik](https://aformatik.de/kontakt):
For professional support, please contact [aformatik](https://www.aformatik.de/kontakt):

- **Feature Requests & Issues**: We offer dedicated assistance for feature requests, bug fixes, and troubleshooting.
- **Training and Consulting**: Need help building a tailored *code machine* for your organization? We provide specialized training and consulting services to help you leverage Codchi to its full potential in your environment.
Expand Down
12 changes: 6 additions & 6 deletions codchi/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ type DefaultLogLevel = InfoLevel;
about = "Codchi is a tool that manages your project's development environment in a reproducible
and easy-to-use way. Setting up a development environment should be as easy as a `git clone`!
- [What is Codchi?](https://codchi.dev/docs/start/intro)
- [Configuring Codchi](https://codchi.dev/docs/start/config)
- [Codchi Module Configuration](https://codchi.dev/docs/config/overview)
- [What is Codchi?](https://codchi.dev/introduction/what-is-codchi)
- [Configuring Codchi](https://codchi.dev/introduction/config)
- [Codchi Module Configuration](https://codchi.dev/config/overview)
The default subcommand is `codchi status`.",
after_long_help = r#"
Expand Down Expand Up @@ -436,9 +436,9 @@ codchi gc --all --delete-old
long_about = r#"
See the following docs on how to register the completions with your shell:
- [Windows](https://codchi.dev/docs/start/installation.html#shell-completions)
- [Linux](https://codchi.dev/docs/start/installation.html#shell-completions-1)
- [NixOS](https://codchi.dev/docs/start/installation.html#shell-completions-2)
- [Windows](https://codchi.dev/introduction/installation#shell-completions)
- [Linux](https://codchi.dev/introduction/installation#shell-completions-1)
- [NixOS](https://codchi.dev/introduction/installation#shell-completions-2)
"#
)]
Completion {
Expand Down
4 changes: 2 additions & 2 deletions codchi/src/module.rs
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ pub fn fetch_modules(
} else if Driver::store().cmd().has_nixpkgs_input(&nix_url)? {
log::warn!(
"Using nixpkgs from '{}'! You may override this with '--use-nixpkgs'. See \
<https://codchi.dev/docs/start/usage.html#which-nixpkgs-should-i-use> for \
<https://codchi.dev/usage/init#which-nixpkgs-should-i-use> for \
more information.",
flake_url.pretty_print()
);
Expand Down Expand Up @@ -537,7 +537,7 @@ fn inquire_module_url(
bail!(
"Local paths can only be used *after* the code machine was created and the \
remote repository was checked out locally. For further information see \
<https://codchi.dev/docs/start/usage.html#local-configuration>."
<https://codchi.dev/usage/module/module#local-configuration>."
)
}
let home = &consts::user::DEFAULT_HOME.0;
Expand Down
2 changes: 1 addition & 1 deletion codchi/src/platform/cmd/nix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ pub enum Error {
#[error("SSL peer certificate or SSH remote key was not OK.")]
InvalidRemoteSSLOrSSH,

#[error("Couldn't access repository. If the repository is private you need to provide the correct credentials. If it's a local repository, make sure it is checked out locally in the machine at the provided path. See <https://codchi.dev/docs/start/usage.html#creating-a-machine> on how to access private repositories.")]
#[error("Couldn't access repository. If the repository is private you need to provide the correct credentials. If it's a local repository, make sure it is checked out locally in the machine at the provided path. See `codchi init --help` on how to access private repositories.")]
InvalidURLOrCredentials,

#[error("There is a file missing (maybe its wasn't added to git): {0}")]
Expand Down
2 changes: 1 addition & 1 deletion codchi/src/platform/linux/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ impl Store for StoreImpl {
fn start_or_init_container() -> Result<Self> {
let status = lxd::container::get_platform_status(consts::CONTAINER_STORE_NAME).context(
"Failed to run LXD. It seems like LXD is not installed or set up correctly! \
Please see <https://codchi.dev/docs/start/installation.html#linux> for setup instructions!",
Please see <https://codchi.dev/introduction/installation#linux> for setup instructions!",
)?;
trace!("LXD store container status: {status:#?}");

Expand Down
6 changes: 3 additions & 3 deletions codchi/src/platform/windows/wsl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ pub fn get_api() -> Result<&'static Library> {
static WSLAPI: OnceLock<Library> = OnceLock::new();
WSLAPI.get_or_try_init(Library::new).context(
"Failed to load wslapi.dll. This usually means the Windows feature 'Windows Subsystem for \
Linux' is not active. Please see <https://codchi.dev/docs/start/installation.html#prerequisites> \
Linux' is not active. Please see <https://codchi.dev/introduction/installation#prerequisites> \
for the installation instructions.",
)
}
Expand All @@ -67,7 +67,7 @@ pub fn get_wsl_version() -> Result<String> {
.filter(|version| Version::from(version).is_some())
.ok_or(anyhow!(
"Failed to parse WSL's version from output '{version_line:?}'. \
Please see <https://codchi.dev/docs/start/installation.html#prerequisites> \
Please see <https://codchi.dev/introduction/installation#prerequisites> \
for the installation instructions."
))
}
Expand Down Expand Up @@ -200,7 +200,7 @@ including all running programs. Is this OK?",
log::warn!(
"WSL distro {name} was NOT set to sparse. \
You can do this manually with `wsl.exe --manage {name} --set-sparse true`. \
See <https://codchi.dev/docs/start/usage.html#large-wsl-distributions> for more information."
See <https://codchi.dev/usage/gc#large-wsl-distributions> for more information."
);
return Ok(());
}
Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.config/2.secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Jul 09 09:38:52 nixos my-secret-service-start[173]: Got secret CODCHI_TEST=My Se
Jul 09 09:38:52 nixos systemd[1]: my-secret-service.service: Deactivated successfully.
```

Refer to the [NixOS Options Reference](/docs/options.html#codchisecretsenv) for more details.
Refer to the [NixOS Options Reference](/config/codchi-specific-nixos-options#codchisecretsenv) for more details.

## Modifying secrets

Expand Down
4 changes: 2 additions & 2 deletions docs/content/3.config/3.misc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ When opening a shell into a code machine, the user is greeted with the following
To get started with Codchi, read the docs at <https://codchi.dev/>.
If you encounter problems please open an issue at <https://github.com/aformatik/codchi/issues>.
```
To customize this, for example to give the user instructions on how to procceed further, there is [`codchi.welcome.text`](/docs/options.html#codchiwelcometext) and [`codchi.welcome.extraText`](/docs/options.html#codchiwelcomeextratext).
To customize this, for example to give the user instructions on how to procceed further, there is [`codchi.welcome.text`](./99.Codchi specific NixOS Options.md#codchiwelcometext) and [`codchi.welcome.extraText`](./99.Codchi specific NixOS Options.md#codchiwelcomeextratext).

## Docker

Docker works normally in Codchi, but the user `codchi` has to be added to the corresponding group in order to not require `sudo`. Codchi provides the convenience option [`codchi.docker.enable`](/docs/options.html#codchidockerenable) for this.
Docker works normally in Codchi, but the user `codchi` has to be added to the corresponding group in order to not require `sudo`. Codchi provides the convenience option [`codchi.docker.enable`](./99.Codchi specific NixOS Options.md#codchidockerenable) for this.

```nix
{ pkgs, ... }: {
Expand Down
4 changes: 2 additions & 2 deletions docs/content/3.config/4.devenv.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Because a code machine is just a NixOS machine with flakes enabled, even a empty
nix-direnv.enable = true;
};
# See <https://codchi.dev/docs/config/editor.html> on how to add an editor
# See <https://codchi.dev/config/editor> on how to add an editor
}
```

Expand All @@ -39,6 +39,6 @@ As described in [the intro](../1.introduction/0.what-is-codchi.md#when-should-i-
# Or see <https://flox.dev/docs/install-flox/#install-flox-from-scratch> on how to install flox
];
# See <https://codchi.dev/docs/config/examples/editor.html> on how to add an editor
# See <https://codchi.dev/config/editor> on how to add an editor
}
```
2 changes: 1 addition & 1 deletion docs/content/3.config/6.environments/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Try it out with `codchi init <NAME> https://github.com/aformatik/codchi nixosMod
# pkgs.nodePackages.prettier
# Editor:
# See <https://codchi.dev/docs/config/editor.html> for more info
# See <https://codchi.dev/config/editor> for more info
pkgs.vscodium
# Or, if you have problems with manually installed plugins:
# pkgs.vscodium-fhs
Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.config/6.environments/jvm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Try it out with `codchi init <NAME> https://github.com/aformatik/codchi nixosMod

## General, Java & Kotlin

IntelliJ wants to download JDKs automatically, but they don't work on NixOS. Therefore you need to enable `programs.java` which sets `$JAVA_HOME` to the default JDK (OpenJDK) which IntelliJ can use. If multiple JDKs are needed, use [`programs.java.packages`](/docs/options.html#programsjavapackages) (an option added by Codchi) which installes them in `~/.jdks`.
IntelliJ wants to download JDKs automatically, but they don't work on NixOS. Therefore you need to enable `programs.java` which sets `$JAVA_HOME` to the default JDK (OpenJDK) which IntelliJ can use. If multiple JDKs are needed, use [`programs.java.packages`](../99.Codchi specific NixOS Options.md#programsjavapackages) (an option added by Codchi) which installes them in `~/.jdks`.

```nix
{ pkgs, ... }: {
Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.config/6.environments/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Try it out with `codchi init <NAME> https://github.com/aformatik/codchi nixosMod
pkgs.python39Packages.virtualenv
# Editor:
# See <https://codchi.dev/docs/config/editor.html> for more info
# See <https://codchi.dev/config/editor> for more info
pkgs.jetbrains.pycharm-community
# Or VSCode(ium)
(pkgs.vscode-with-extensions.override {
Expand Down
Loading

0 comments on commit 8895e89

Please sign in to comment.