Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 74 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,74 @@
# agentic-devops-sample
agentic devops sample
# Agentic DevOps Sample

Welcome to the Agentic DevOps Sample repository! This repository contains resources for learning and presenting about agentic DevOps practices.

## πŸ“¦ What's Included

### Event in a Box

A complete package for delivering presentations and workshops on agentic DevOps. Perfect for speakers, trainers, and technical evangelists.

**[Get Started with Event in a Box β†’](./event-in-a-box/README.md)**

What you'll find:
- πŸ“Š **Presentation Materials**: Ready-to-use slide decks and speaker notes
- 🎬 **Demo Scripts**: Step-by-step demonstration guides
- πŸŽ“ **Workshop Content**: Hands-on labs and exercises
- πŸ› οΈ **Setup Guides**: Technical setup instructions
- πŸ“š **Resources**: FAQs, troubleshooting, and additional materials

## 🎯 Use Cases

- Deliver conference talks on agentic DevOps
- Run internal training sessions
- Host community workshops
- Create educational content
- Learn about intelligent automation in DevOps

## πŸš€ Quick Start

### For Presenters

1. Browse the [Event in a Box](./event-in-a-box/) materials
2. Review the [Speaker Guide](./event-in-a-box/speaker-guide.md)
3. Set up the [Demo Environment](./event-in-a-box/setup/demo-setup.md)
4. Customize the [Presentation](./event-in-a-box/presentation/slides.md)
5. Practice with the [Demo Scripts](./event-in-a-box/demos/README.md)

### For Learners

1. Explore the [Event in a Box](./event-in-a-box/) to understand concepts
2. Try the [Workshop Labs](./event-in-a-box/workshop/README.md)
3. Read the [FAQ](./event-in-a-box/resources/faq.md)
4. Check out example implementations

## πŸ“– Learn More

- **What is Agentic DevOps?** - Intelligent, autonomous systems that make decisions and take actions within DevOps workflows
- **Why Agentic DevOps?** - Faster response times, reduced toil, improved reliability, enhanced scalability
- **How to Get Started?** - See the [Event in a Box README](./event-in-a-box/README.md)

## 🀝 Contributing

We welcome contributions! Whether you want to:
- Improve documentation
- Add new demos
- Create workshop content
- Share your experiences
- Fix bugs or typos

Please see [CONTRIBUTING.md](./event-in-a-box/CONTRIBUTING.md) for guidelines.

## πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

## πŸ’¬ Community

- **Discussions**: Share ideas and ask questions
- **Issues**: Report bugs or request features
- **Pull Requests**: Contribute improvements

## πŸ™ Acknowledgments

Thanks to all contributors who have helped build and improve these materials!
266 changes: 266 additions & 0 deletions event-in-a-box/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,266 @@
# Contributing to Event in a Box

Thank you for your interest in contributing to the Agentic DevOps Event in a Box! This guide will help you get started.

## How to Contribute

There are many ways to contribute:

### πŸ“ Content Contributions
- Improve documentation
- Add new demo scripts
- Create workshop exercises
- Write blog posts or tutorials
- Translate content

### πŸ› Bug Reports
- Report issues with setup instructions
- Document problems with demos
- Identify outdated content

### πŸ’‘ Feature Requests
- Suggest new demos
- Propose new workshop modules
- Request additional resources

### 🎨 Design Improvements
- Improve slide templates
- Create diagrams and visualizations
- Design promotional materials

### πŸ§ͺ Testing
- Test demos in different environments
- Validate workshop materials
- Provide feedback on content

## Getting Started

### 1. Fork the Repository

```bash
# Fork on GitHub, then clone your fork
git clone https://github.com/YOUR-USERNAME/agentic-devops-sample
cd agentic-devops-sample
```

### 2. Create a Branch

```bash
# Create a descriptive branch name
git checkout -b feature/add-kubernetes-demo
# or
git checkout -b fix/update-setup-instructions
# or
git checkout -b docs/improve-speaker-guide
```

### 3. Make Your Changes

Follow these guidelines:

#### Documentation
- Use clear, concise language
- Include examples where helpful
- Test all commands and code snippets
- Check spelling and grammar
- Follow existing formatting style

#### Demo Scripts
- Include prerequisites
- Provide step-by-step instructions
- Add troubleshooting tips
- Test in clean environment
- Include expected output

#### Code
- Follow existing code style
- Add comments for complex logic
- Include error handling
- Write tests if applicable
- Update documentation

### 4. Test Your Changes

```bash
# Test documentation links
markdown-link-check **/*.md

# Test demo scripts
cd event-in-a-box/demos
./test-all-demos.sh

# Spell check
aspell check file.md
```

### 5. Commit Your Changes

Write clear, descriptive commit messages:

```bash
# Good commit messages
git commit -m "Add Kubernetes demo script with troubleshooting section"
git commit -m "Fix broken link in setup guide"
git commit -m "Update Python requirements for security patches"

# Less helpful commit messages (avoid these)
git commit -m "Update docs"
git commit -m "Fix stuff"
git commit -m "WIP"
```

### 6. Push and Create Pull Request

```bash
# Push to your fork
git push origin feature/add-kubernetes-demo

# Create pull request on GitHub
# Provide clear description of changes
```

## Pull Request Guidelines

### PR Description Template

```markdown
## Description
Brief description of what this PR does.

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Content improvement
- [ ] Other (please describe)

## Changes Made
- Bullet point list of specific changes

## Testing Done
- How you tested these changes
- Environments tested in

## Screenshots (if applicable)
Add screenshots to help explain your changes

## Checklist
- [ ] I have tested these changes
- [ ] Documentation is updated
- [ ] All links work
- [ ] Code follows style guidelines
- [ ] Commit messages are clear
```

### Review Process

1. **Automated Checks**: CI will run automatically
2. **Maintainer Review**: A maintainer will review your PR
3. **Feedback**: Address any requested changes
4. **Approval**: Once approved, your PR will be merged

## Content Guidelines

### Writing Style

- **Be Clear**: Use simple, straightforward language
- **Be Concise**: Get to the point quickly
- **Be Practical**: Include real examples
- **Be Inclusive**: Use inclusive language
- **Be Accurate**: Test everything you document

### Formatting Standards

#### Markdown
```markdown
# Main Title (H1)

## Section (H2)

### Subsection (H3)

**Bold** for emphasis
*Italic* for slight emphasis
`code` for inline code
```

#### Code Blocks
```markdown
```bash
# Always specify language
# Include comments
command --with-flags
```
```

#### Links
```markdown
[Descriptive Text](./relative/path/to/file.md)
[External Link](https://example.com)
```

### Demo Script Standards

Every demo should include:

1. **Overview**: What it demonstrates
2. **Duration**: How long it takes
3. **Difficulty**: Beginner/Intermediate/Advanced
4. **Prerequisites**: What's needed
5. **Setup**: Preparation steps
6. **Script**: Step-by-step instructions
7. **Common Issues**: Troubleshooting
8. **Cleanup**: How to reset

### Workshop Material Standards

Every lab should include:

1. **Learning Objectives**: What participants will learn
2. **Prerequisites**: Required knowledge
3. **Instructions**: Clear steps
4. **Starter Code**: Template to begin
5. **Solution**: Reference implementation
6. **Tests**: Validation
7. **Extensions**: Optional challenges

## Code of Conduct

### Our Standards

- **Be Respectful**: Treat everyone with respect
- **Be Collaborative**: Work together constructively
- **Be Inclusive**: Welcome diverse perspectives
- **Be Patient**: Everyone is learning
- **Be Professional**: Keep discussions on-topic

### Unacceptable Behavior

- Harassment or discrimination
- Trolling or insulting comments
- Personal attacks
- Publishing private information
- Other unprofessional conduct

## Recognition

Contributors will be recognized in:
- README contributors section
- Release notes
- Community highlights
- Speaker acknowledgments (if you present using these materials)

## Questions?

- πŸ’¬ **Discussions**: Use GitHub Discussions for questions
- πŸ“§ **Email**: [maintainer-email]
- πŸ’‘ **Issues**: Open an issue for bugs or features
- πŸ“£ **Slack/Discord**: Join the community channel

## License

By contributing, you agree that your contributions will be licensed under the same license as the project.

## Thank You!

Your contributions help make this resource better for everyone. We appreciate your time and effort! πŸŽ‰
Loading