58 lines
1.9 KiB
Markdown
58 lines
1.9 KiB
Markdown
# SGO Wiki
|
|
|
|
This directory contains comprehensive documentation for SGO (Security Groups Observatory).
|
|
|
|
## Wiki Pages
|
|
|
|
### Getting Started
|
|
- **[Home](Home.md)** - Project overview, features, and file structure
|
|
- **[Quick Start](Quick-Start.md)** - Get up and running in 30 seconds
|
|
|
|
### Configuration
|
|
- **[Configuration](Configuration.md)** - Environment variables, data storage options, and configuration examples
|
|
- **[AWS Configuration](AWS-Configuration.md)** - AWS profile setup, MFA configuration, and IAM permissions
|
|
|
|
### Usage
|
|
- **[Usage Guide](Usage.md)** - Complete guide to using SGO features including search, views, and CSV exports
|
|
- **[FAQ](FAQ.md)** - Frequently asked questions
|
|
|
|
### Help
|
|
- **[Troubleshooting](Troubleshooting.md)** - Common issues and solutions
|
|
|
|
## Using These Docs
|
|
|
|
### For New Users
|
|
|
|
1. Start with [Quick Start](Quick-Start.md) to get SGO running
|
|
2. Read [AWS Configuration](AWS-Configuration.md) to set up your AWS profiles
|
|
3. Check [Usage Guide](Usage.md) to learn the features
|
|
|
|
### For Troubleshooting
|
|
|
|
1. Check [FAQ](FAQ.md) for common questions
|
|
2. Review [Troubleshooting](Troubleshooting.md) for specific error messages
|
|
3. If still stuck, open an issue with logs and details
|
|
|
|
### For Configuration
|
|
|
|
1. See [Configuration](Configuration.md) for all environment variables
|
|
2. Review configuration examples for your use case
|
|
3. Check platform-specific notes if on Windows/macOS/Linux
|
|
|
|
## Contributing to Documentation
|
|
|
|
Found an error or want to improve the docs?
|
|
|
|
1. Edit the relevant markdown file
|
|
2. Submit a pull request
|
|
3. Follow the contribution guidelines in [CONTRIBUTING.md](../CONTRIBUTING.md)
|
|
|
|
## Publishing to Wiki
|
|
|
|
These markdown files can be:
|
|
- Used directly in the repository
|
|
- Published to GitHub/Codeberg wiki pages
|
|
- Rendered with any markdown viewer
|
|
- Hosted on documentation platforms
|
|
|
|
For Codeberg, these files can be copied to the repository's wiki section.
|