Using abra man to document narrative + solutions for common issues #569

Closed
opened 2025-06-05 12:43:22 +00:00 by decentral1se · 1 comment
Owner

Follows #568. Our error messages are improving but they're still geared towards experience sysadmins (our original intention to cater towards this group). We have more and more sysadmins getting into the game who don't have years of chaos troubleshooting behind them and we'd like to help them!

There is a proposal to somehow write some narrative / user-friendly / solutions within abra itself. This could be somehow added to what abra man generates, so that a user could do man abra-ssh or something to get the help in the terminal.

The advantage of this is not pointing to a URL on the web that is maybe gone after some time.

It was mentioned that it would be nice if this could also be ported into the documentation on the web also.

/cc @ammaratef45 @3wordchant @trav et al

Follows https://git.coopcloud.tech/toolshed/abra/issues/568. Our error messages are improving but they're still geared towards experience sysadmins (our original intention to cater towards this group). We have more and more sysadmins getting into the game who don't have years of chaos troubleshooting behind them and we'd like to help them! There is a proposal to somehow write some narrative / user-friendly / solutions within `abra` itself. This could be somehow added to what `abra man` generates, so that a user could do `man abra-ssh` or something to get the help in the terminal. The advantage of this is not pointing to a URL on the web that is maybe gone after some time. It was mentioned that it would be nice if this could also be ported into the documentation on the web also. /cc @ammaratef45 @3wordchant @trav et al
decentral1se added the
enhancement
label 2025-06-05 12:43:22 +00:00
Author
Owner

I think we're still in agreement with this issue but given the new internationalisation angle, I am not sure how this would pan out. There is still a big question about a new docs platform also in toolshed/organising#665. I think this ticket isn't that actionable right now because a lot is up in the air. I'm gonna close it and let's see if the idea comes back.

I think we're still in agreement with this issue but given the new [internationalisation](https://docs.coopcloud.tech/abra/hack/#internationalisation) angle, I am not sure how this would pan out. There is still a big question about a new docs platform also in https://git.coopcloud.tech/toolshed/organising/issues/665. I think this ticket isn't that actionable right now because a lot is up in the air. I'm gonna close it and let's see if the idea comes back.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: toolshed/abra#569
No description provided.