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

User guide #55

Open
Notgnoshi opened this issue Oct 20, 2024 · 0 comments
Open

User guide #55

Notgnoshi opened this issue Oct 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Notgnoshi
Copy link
Owner

Notgnoshi commented Oct 20, 2024 •
edited
Loading

The README will be too large an overwhelming if it documents everything, so put together a docs/getting-started.md document, that should cover:

  1. Installation
  2. Application configuration
    1. Where to find
    2. Rule settings
  3. Adding repositories
    1. Auth
    2. Re-using existing checkouts
  4. Running Herostratus regularly (cron / systemd timer)
  5. Integrations (future)
@Notgnoshi Notgnoshi added the documentation Improvements or additions to documentation label Oct 20, 2024
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Notgnoshi