aws / aws/aws-ec2-instance-connect-config

Please provide better documentation, preferably manpages

Open
#24 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
88
Forks
39
PR merge metrics
No merged PRs in 30d

Description

Hello!

I'm currently packaging ```aws-ec2-instance-connect-config``` for openSUSE/SLE but I'm having a hard time properly testing the package due to lack of documentation.

It would be great if there were some simple manpages which explain exactly what each command does and which parameters they have and what they do.

Thanks!

Contributor guide

Open the contributing guide

Research direction

Inventory the command scripts and package contents in the repository, then identify each command and its parameters. Draft manpages that explain what the commands do and document their parameters, and verify that the resulting documentation covers the commands needed to test the openSUSE/SLE package.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.