From 03fa49341b4fa4117060001dfa2561186c2c9baa Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 24 Sep 2026 18:35:10 +0200 Subject: [PATCH] add justfile rule for manual book update command --- README.md | 9 +++++---- justfile | 5 +++++ satrs-book/README.md | 2 +- satrs-example/README.md | 2 +- satrs-mib/Cargo.toml | 2 +- satrs-shared/Cargo.toml | 2 +- satrs/src/legacy/event_man.rs | 2 +- satrs/src/legacy/event_man_legacy.rs | 2 +- satrs/src/lib.rs | 2 +- satrs/src/tmtc/mod.rs | 2 +- tmtc-utils/Cargo.toml | 2 +- 11 files changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 07e0ba0..4bc6ee4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

-[![sat-rs book](https://img.shields.io/badge/sat--rs-book-darkgreen?style=flat)](https://robamu.github.io/sat-rs/book/) +[![sat-rs book](https://img.shields.io/badge/sat--rs-book-darkgreen?style=flat)](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/) [![Crates.io](https://img.shields.io/crates/v/satrs)](https://crates.io/crates/satrs) [![docs.rs](https://img.shields.io/docsrs/satrs)](https://docs.rs/satrs) [![matrix chat](https://img.shields.io/matrix/sat-rs%3Amatrix.org)](https://matrix.to/#/#sat-rs:matrix.org) @@ -10,8 +10,9 @@ sat-rs This is the repository of the sat-rs library. Its primary goal is to provide re-usable components to write on-board software for remote systems like rovers or satellites. It is specifically written -for the special requirements for these systems. You can find an overview of the project in the -[more high-level sat-rs book](https://robamu.github.io/sat-rs/book/). +for the special requirements for these systems. You can find an overview of the project and the +link to the [more high-level sat-rs book](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/) +at the [IRS software projects website](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/). This is early-stage software. Important features are missing. New releases with breaking changes are released regularly, with all changes documented inside respective @@ -29,7 +30,7 @@ This project currently contains following crates: * [`satrs-book`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-book): Primary information resource in addition to the API documentation, hosted - [here](https://robamu.github.io/sat-rs/book/). It can be useful to read + [here](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/). It can be useful to read this first before delving into the example application and the API documentation. * [`satrs`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs): Primary crate. diff --git a/justfile b/justfile index bed5cdd..dff375a 100644 --- a/justfile +++ b/justfile @@ -39,3 +39,8 @@ docs: docs-satrs [working-directory:"satrs-book"] book *args: mdbook build {{args}} + +# Pass --dry-run to preview the changes first. +[working-directory:"satrs-book"] +deploy-book *args: book + rsync -avz --delete {{args}} book/html/ numalfix@documentation.irs.uni-stuttgart.de:/home/numalfix/www/projects/sat-rs/book/ diff --git a/satrs-book/README.md b/satrs-book/README.md index 7243806..f2c0293 100644 --- a/satrs-book/README.md +++ b/satrs-book/README.md @@ -1,7 +1,7 @@ sat-rs book ========= -High-level documentation of the [sat-rs project](https://egit.irs.uni-stuttgart.de/rust/sat-rs). +High-level documentation of the [sat-rs project](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/). ## Building diff --git a/satrs-example/README.md b/satrs-example/README.md index 825933d..4e176f0 100644 --- a/satrs-example/README.md +++ b/satrs-example/README.md @@ -5,7 +5,7 @@ This crate contains an example application which simulates an on-board software. It uses various components provided by the sat-rs framework to do this. As such, it shows how a more complex real on-board software could be built from these components. It is recommended to read the dedicated -[example chapters](https://robamu.github.io/sat-rs/book/example.html) inside +[example chapters](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/example.html) inside the sat-rs book. The application opens a UDP and a TCP server on port 7301 to receive telecommands. diff --git a/satrs-mib/Cargo.toml b/satrs-mib/Cargo.toml index ed59c0d..31da8ba 100644 --- a/satrs-mib/Cargo.toml +++ b/satrs-mib/Cargo.toml @@ -6,7 +6,7 @@ rust-version = "1.61" description = """ Helper crate of the sat-rs framework to build a mission information base (MIB) from the On-Board Software (OBSW) code directly.""" -homepage = "https://robamu.github.io/sat-rs/book/" +homepage = "https://documentation.irs.uni-stuttgart.de/projects/sat-rs/" repository = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" license = "Apache-2.0" keywords = ["no-std", "space", "aerospace"] diff --git a/satrs-shared/Cargo.toml b/satrs-shared/Cargo.toml index e09bf09..d5e1130 100644 --- a/satrs-shared/Cargo.toml +++ b/satrs-shared/Cargo.toml @@ -3,7 +3,7 @@ name = "satrs-shared" description = "Components shared by multiple sat-rs crates" version = "0.2.4" edition = "2021" -homepage = "https://robamu.github.io/sat-rs/book/" +homepage = "https://documentation.irs.uni-stuttgart.de/projects/sat-rs/" repository = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" license = "Apache-2.0" diff --git a/satrs/src/legacy/event_man.rs b/satrs/src/legacy/event_man.rs index a4d944c..81dd35a 100644 --- a/satrs/src/legacy/event_man.rs +++ b/satrs/src/legacy/event_man.rs @@ -1,7 +1,7 @@ //! Event management and forwarding //! //! It is recommended to read the -//! [sat-rs book chapter](https://robamu.github.io/sat-rs/book/events.html) +//! [sat-rs book chapter](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/events.html) //! about events first. //! //! This module provides components to perform event routing. The most important component for this diff --git a/satrs/src/legacy/event_man_legacy.rs b/satrs/src/legacy/event_man_legacy.rs index 3660777..d435703 100644 --- a/satrs/src/legacy/event_man_legacy.rs +++ b/satrs/src/legacy/event_man_legacy.rs @@ -3,7 +3,7 @@ //! This is a legacy module. It is recommended to use [super::event_man] instead. //! //! It is recommended to read the -//! [sat-rs book chapter](https://robamu.github.io/sat-rs/book/events.html) +//! [sat-rs book chapter](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/events.html) //! about events first. //! //! This module provides components to perform event routing. The most important component for this diff --git a/satrs/src/lib.rs b/satrs/src/lib.rs index 533b880..a842765 100644 --- a/satrs/src/lib.rs +++ b/satrs/src/lib.rs @@ -1,6 +1,6 @@ //! # sat-rs: A helper library to build on-board software for remote systems //! -//! The [satrs-book](https://robamu.github.io/sat-rs/book/) contains +//! The [satrs-book](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/) contains //! high-level information about this library. #![no_std] #![cfg_attr(docsrs, feature(doc_cfg))] diff --git a/satrs/src/tmtc/mod.rs b/satrs/src/tmtc/mod.rs index 57bc3ba..19e6597 100644 --- a/satrs/src/tmtc/mod.rs +++ b/satrs/src/tmtc/mod.rs @@ -1,7 +1,7 @@ //! Telemetry and Telecommanding (TMTC) module. Contains packet routing components with special //! support for CCSDS and ECSS packets. //! -//! It is recommended to read the [sat-rs book chapter](https://robamu.github.io/sat-rs/book/communication.html) +//! It is recommended to read the [sat-rs book chapter](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/book/communication.html) //! about communication first. The TMTC abstractions provided by this framework are based on the //! assumption that all telemetry is sent to a special handler object called the TM sink while //! all received telecommands are sent to a special handler object called TC source. Using diff --git a/tmtc-utils/Cargo.toml b/tmtc-utils/Cargo.toml index da71d93..6bd26d3 100644 --- a/tmtc-utils/Cargo.toml +++ b/tmtc-utils/Cargo.toml @@ -3,7 +3,7 @@ name = "tmtc-utils" description = "Commonly required utilities for writing TMTC clients with Rust" version = "0.1.0" edition = "2024" -homepage = "https://robamu.github.io/sat-rs/book/" +homepage = "https://documentation.irs.uni-stuttgart.de/projects/sat-rs/" repository = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" license = "Apache-2.0"