Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Increase Documentation Coverage #22

Open
3 tasks
deven96 opened this issue Nov 10, 2022 · 4 comments
Open
3 tasks

Increase Documentation Coverage #22

deven96 opened this issue Nov 10, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@deven96
Copy link
Member

deven96 commented Nov 10, 2022 •
edited
Loading

  • Document Inspectors rather than just leaving an example config file?
  • Also fix readme for starting in dev mode on supported platforms
  • Create Demo video that shows from start to finish how to download the binary for a specific platform, cat a config file that has local, ssh-password, ssh-file logins and has individual metrics
@deven96 deven96 added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 10, 2022
@deven96
Copy link
Member Author

deven96 commented Jan 6, 2023

Also fix readme for starting in dev mode on supported platforms

@deven96 deven96 changed the title More Documentation for Inspectors (Metrics)? Increase Documentation Coverage Jan 6, 2023
@deven96
Copy link
Member Author

deven96 commented Jan 6, 2023 •
edited
Loading

  • Use byzanz
  • Download the saido binary for the specified OS
  • Cat the config file (To show the 3 different kinds of servers)
    **** At first no custom metric for any server
    **** When catting the config file, use a fake that replaces the actual username and password of the server you're connecting to
  • Later on can add custom metric for a particular server (README) .... show particularly how to indent appropriately for the server you want custom metrics from
  • Start the saido binary using the config file.... (make sure polling time is 10 seconds)
  • Wait for frontend to pop up and see different servers and then go through all metrics. See all metrics allowed currently in inspector.go
  • Show the graphs....
  • End session

@deven96
Copy link
Member Author

deven96 commented Jan 6, 2023 •
edited
Loading

README considerations

  • Add a hyperlink to Hausa
  • Move consideration note into development category
  • Terminal arguments (copy paste from help prompt) CLI
  • Structure of config file (Configuration)
    • how to set metrics globally vs individual servers
    • how to use ssh key file
    • how to use passworded ssh key file
    • how to monitor localhost aka the current server you're on
    • Show how to add custom metric .... make sure for any string within the config file you use single quotes
    • Also note the broad assumptions we make aka the host names are treated as unique.... we've currently only tested on Mac, Windows11 and Linux Ubuntu 20.04 LTS
  • Installation.... show how you would install on Mac, Windows and Linux.... use the latest version
  • Rewrite Development requirements/installation

@deven96
Copy link
Member Author

deven96 commented Jan 6, 2023 •
edited
Loading

  • Simple article for using SSH in Golang? (Fullstack development with golang ... build flags and embed)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@deven96