Admin command documentation and journald logging suport #892

Merged

Jade merged 3 commits from jade/admin-command-docs into main 2025-07-07 01:40:14 +00:00

Conversation 1 Commits 3 Files changed 49 +3278 -172

Jade commented 2025-07-06 18:54:47 +00:00

Owner

Copy link

This gets basic generated admin command docs on the website. Also adds (relatively untested) journald logging support, before we add more fancy logging.

This gets basic generated admin command docs on the website. Also adds (relatively untested) journald logging support, before we add more fancy logging.

Jade added 2 commits 2025-07-06 18:54:47 +00:00

feat: Support logging to journald with tracing-journald ... acf958c2a4

This stubs out on non-unix platforms.

feat: Generate admin command documentation ... 428c4fc25e

The first part of getting admin command docs on the website.

There's also the beginnings of manpage generation here, although it's
kinda sus and I'm not sure how it's supposed to work. I'll leave that to
anyone who wants to package it.

We introduce the beginings of the xtask pattern here - we do a lot of
file generation, I thought it would be best to avoid doing that on every
compilation. It also helps avoid lots of runtime deps.

We'll need to document generating this stuff & probably add pre-commit
hooks for it, though.

Jade added the

Documentation

Enhancement

labels 2025-07-06 18:54:56 +00:00

Jade added 1 commit 2025-07-06 19:02:20 +00:00

fix: Re-export clap a74c2d9ee6

Jade force-pushed jade/admin-command-docs from a74c2d9ee6 to cc6082a354 2025-07-06 19:19:05 +00:00 Compare

Jade added 1 commit 2025-07-06 20:59:25 +00:00

feat: Generate binary documentation ... 96b8a78bc5

Also refactors main.rs/mod.rs to silence clippy

Jade requested review from nex 2025-07-06 21:01:01 +00:00

Jade force-pushed jade/admin-command-docs from 96b8a78bc5 to ba2fc0040d 2025-07-06 21:53:23 +00:00 Compare

Jade force-pushed jade/admin-command-docs from ba2fc0040d to 28a29c3a7b 2025-07-06 21:58:06 +00:00 Compare

nex approved these changes 2025-07-07 01:19:12 +00:00

Jade merged commit 28a29c3a7b into main 2025-07-07 01:40:14 +00:00

Jade added this to the v0.5.0-rc.7 milestone 2025-07-25 12:45:10 +00:00

Sign in to join this conversation.

Reviewers

No reviewers

nex

Labels

Clear labels   

Bug

Something isn't working as intended

  

Cherry-picking

Commits picked from other conduit projects

  

Database

This requires or includes changes to the database

  

Dependencies

Something dependency related

  

Dependencies/Renovate

Automatic dependency upgrades by Renovate

  

Difficulty

Easy

Low difficulty to implement - touches few parts of the codebase, low complexity

  

Difficulty

Hard

High difficulty to implement - touches many parts of the codebase, high complexity

  

Difficulty

Medium

Medium difficulty to implement - touches more parts of the codebase, higher complexity

  

Documentation

Improvements or additions to documentation

  

Enhancement

New feature or request

  

Good first issue

Good for newcomers

  

Help wanted

Additional eyes and keyboards are required for this one

  

Inherited

Issues that have been inhereted from the project pre-fork

  

Matrix/Administration

Features pertaining to homeserver administration

  

Matrix/Appservices

Features pertaining to the appservice API

  

Matrix/Auth

Features pertaining to authentication

  

Matrix/Client

Features pertaining to client-to-server interactions

  

Matrix/Core

Issues relating to core matrix functionality, such as state resolution and PDU formats

  

Matrix/Federation

Features pertaining to server-to-server interactions

  

Matrix/MSC

Features pertaining to unstable matrix features

  

Matrix/Media

Features pertaining to media interactions

  

Meta

Related to housekeeping, maintenance, or other repo-meta.

  

Meta/Packaging

Packaging

  

Priority

Blocking

This issue is blocking the next release

  

Priority

High

This issue is very important

  

Priority

Low

This issue is of a rather low priority

  

Security

This item is related to general security

  

Status

Confirmed

  

Status

Duplicate

This issue or pull request already exists

  

Status

Invalid

This issue doesn't seem right

  

Status

Needs Investigation

This issue needs further investigation

  

To-Merge

  

Wont fix

This will not be worked on

  

old/ci/cd

Ci/CD

Archived

  

old/rust

Pull requests that update Rust code

Archived

No labels

Bug

Cherry-picking

Database

Dependencies

Dependencies/Renovate

Difficulty

Easy

Difficulty

Hard

Difficulty

Medium

Documentation

Enhancement

Good first issue

Help wanted

Inherited

Matrix/Administration

Matrix/Appservices

Matrix/Auth

Matrix/Client

Matrix/Core

Matrix/Federation

Matrix/MSC

Matrix/Media

Meta

Meta/Packaging

Priority

Blocking

Priority

High

Priority

Low

Security

Status

Confirmed

Status

Duplicate

Status

Invalid

Status

Needs Investigation

To-Merge

Wont fix

old/ci/cd

old/rust

Milestone

Clear milestone

No items

No milestone

v0.5.0-rc.7

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

continuwuation/continuwuity!892

No description provided.