toolshed/abra
toolshed/abra
4
2
Fork 18
Code Issues 27 Pull Requests 3 Packages Releases 40 Activity

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

New Issue
Open
opened 2025-06-05 12:43:22 +00:00 by decentral1se · 0 comments
decentral1se commented 2025-06-05 12:43:22 +00:00
Owner
Copy Link

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
👍 1
decentral1se added the
enhancement
 label 2025-06-05 12:43:22 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
Something is not working
build
go build related issues
ci/cd
Building things with CI/CD
contributing
Dealing with contributing
critical fix
https://docs.coopcloud.tech/federation/resolutions/passed/010/
design
UI/UX
documentation
Documenting all the things
duplicate
This issue or pull request already exists
enhancement
New feature
help wanted
Need some help
invalid
Something is wrong
meta
relating to the project or repo itself
question
More information is needed
release
Release management
release-candidate
Related to the new release candidate
security
Security related
test
Unit/integration testing
wontfix
This won't be fixed
No Label
enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
3wordchant abra-bot ammaratef45 Apfelwurm carla cas decentral1se fauno kawaiipunk knoflook lambdabundesverband moritz p4u1 simon trav val yksflip
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: toolshed/abra#569
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?