https://github.com/bvandewe/events-player
Web app enabling users to monitor, explore, analyze and export streams of CloudEvents. As a subscriber, emitter and reporter, it supports admins operate their Event-Driven Architecture.
https://github.com/bvandewe/events-player
cloudevent cloudevent-tester cloudevents cloudevents-emittter cloudevents-receiver event-driven-architecture event-emitter event-streaming event-subscriber javascript visualization
Last synced: 5 months ago
JSON representation
Web app enabling users to monitor, explore, analyze and export streams of CloudEvents. As a subscriber, emitter and reporter, it supports admins operate their Event-Driven Architecture.
- Host: GitHub
- URL: https://github.com/bvandewe/events-player
- Owner: bvandewe
- License: mit
- Created: 2024-08-26T18:51:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-22T03:14:37.000Z (6 months ago)
- Last Synced: 2025-12-23T14:50:04.385Z (6 months ago)
- Topics: cloudevent, cloudevent-tester, cloudevents, cloudevents-emittter, cloudevents-receiver, event-driven-architecture, event-emitter, event-streaming, event-subscriber, javascript, visualization
- Language: JavaScript
- Homepage: https://bvandewe.github.io/events-player/
- Size: 14.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README-DOCS.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Documentation Deployment
This project uses MkDocs with Material theme for documentation, automatically deployed to both GitHub Pages and GitLab Pages.
## 📚 Documentation Sites
- **GitHub Pages**:
- **GitLab Pages**: Check your GitLab project Settings > Pages for the URL
## 🚀 Automatic Deployment
Documentation is automatically built and deployed when:
### GitHub Pages
- Push to `main` branch
- Create a new tag (e.g., `v0.2.0`)
- Manual workflow dispatch (Actions tab)
### GitLab Pages
- Push to the default branch (`main`)
- Create a new tag
## 📋 Prerequisites
All dependencies are listed in `docs-requirements.txt`:
```bash
pip install -r docs-requirements.txt
```
Or install individually:
```bash
pip install mkdocs mkdocs-material pymdown-extensions
pip install mkdocs-awesome-pages-plugin
pip install mkdocs-git-revision-date-localized-plugin
pip install mike
```
## 🛠️ Local Development
### Serve locally (with auto-reload)
```bash
mkdocs serve
```
Access at:
### Build locally
```bash
mkdocs build --clean --verbose
```
Output in `site/` directory
## 📦 GitHub Pages Setup
⚠️ **CRITICAL**: Change Source to "GitHub Actions" (not branch deployment!)
### One-Time Setup
1. Go to **Settings** > **Pages** in your GitHub repository
2. Under **Source**, select **"GitHub Actions"** (NOT "Deploy from a branch")
3. Push to `main` branch or trigger workflow manually
4. Check **Actions** tab for deployment status
**Current Issue**: If set to "Deploy from a branch", the documentation won't build.
See `GITHUB_PAGES_FIX.md` for detailed instructions.
## 📦 GitLab Pages Setup
GitLab Pages deploys automatically via the `pages` job in `.gitlab-ci.yml`:
1. Check **CI/CD** > **Pipelines** for job status
2. Go to **Settings** > **Pages** to view your docs URL
3. Configure access level (public/private) if needed
## 🔧 Configuration Files
- **mkdocs.yml** - MkDocs configuration
- **docs-requirements.txt** - Python dependencies
- **.github/workflows/deploy-docs.yml** - GitHub Actions workflow
- **.gitlab-ci.yml** - GitLab CI/CD (includes `pages` job)
## 🎨 Customization
- **Content**: Edit Markdown files in `docs/`
- **Theme**: Modify settings in `mkdocs.yml`
- **Styling**: Custom CSS in `docs/assets/css/custom.css`
- **Scripts**: Custom JS in `docs/assets/js/`
## 🔍 Troubleshooting
### GitHub Actions failing
1. Check the **Actions** tab for error logs
2. Verify all dependencies in `docs-requirements.txt` are compatible
3. Ensure GitHub Pages is set to "GitHub Actions" as source
4. Check workflow has proper permissions (pages: write, id-token: write)
### GitLab Pages not deploying
1. Check **CI/CD** > **Pipelines** for the `pages` job status
2. Verify the job creates a `public/` directory
3. Check that `docs-requirements.txt` is present
4. Review job logs for build errors
### Build errors locally
1. Update dependencies: `pip install -r docs-requirements.txt --upgrade`
2. Clear cache: `rm -rf site/`
3. Rebuild: `mkdocs build --clean --verbose`
4. Check for broken links or missing pages
### Missing plugins error
If you see errors about missing plugins, ensure all dependencies are installed:
```bash
pip install -r docs-requirements.txt
```
## 📚 Resources
- [MkDocs Documentation](https://www.mkdocs.org/)
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
- [GitHub Pages](https://docs.github.com/en/pages)
- [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)