{"id":27624869,"url":"https://github.com/bvandewe/events-player","last_synced_at":"2026-01-23T00:29:01.021Z","repository":{"id":254916252,"uuid":"847897970","full_name":"bvandewe/events-player","owner":"bvandewe","description":"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.","archived":false,"fork":false,"pushed_at":"2025-12-22T03:14:37.000Z","size":14851,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-23T14:50:04.385Z","etag":null,"topics":["cloudevent","cloudevent-tester","cloudevents","cloudevents-emittter","cloudevents-receiver","event-driven-architecture","event-emitter","event-streaming","event-subscriber","javascript","visualization"],"latest_commit_sha":null,"homepage":"https://bvandewe.github.io/events-player/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bvandewe.png","metadata":{"files":{"readme":"README-DOCS.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-26T18:51:57.000Z","updated_at":"2025-11-28T22:35:51.000Z","dependencies_parsed_at":"2024-08-27T00:30:54.941Z","dependency_job_id":"df1d9201-41a0-4e61-bc17-6069fe9a42d4","html_url":"https://github.com/bvandewe/events-player","commit_stats":null,"previous_names":["bvandewe/events-player"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/bvandewe/events-player","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bvandewe%2Fevents-player","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bvandewe%2Fevents-player/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bvandewe%2Fevents-player/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bvandewe%2Fevents-player/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bvandewe","download_url":"https://codeload.github.com/bvandewe/events-player/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bvandewe%2Fevents-player/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28676145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T20:48:19.482Z","status":"ssl_error","status_checked_at":"2026-01-22T20:48:14.968Z","response_time":144,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudevent","cloudevent-tester","cloudevents","cloudevents-emittter","cloudevents-receiver","event-driven-architecture","event-emitter","event-streaming","event-subscriber","javascript","visualization"],"created_at":"2025-04-23T11:58:46.392Z","updated_at":"2026-01-23T00:29:01.009Z","avatar_url":"https://github.com/bvandewe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Deployment\n\nThis project uses MkDocs with Material theme for documentation, automatically deployed to both GitHub Pages and GitLab Pages.\n\n## 📚 Documentation Sites\n\n- **GitHub Pages**: \u003chttps://bvandewe.github.io/events-player/\u003e\n- **GitLab Pages**: Check your GitLab project Settings \u003e Pages for the URL\n\n## 🚀 Automatic Deployment\n\nDocumentation is automatically built and deployed when:\n\n### GitHub Pages\n\n- Push to `main` branch\n- Create a new tag (e.g., `v0.2.0`)\n- Manual workflow dispatch (Actions tab)\n\n### GitLab Pages\n\n- Push to the default branch (`main`)\n- Create a new tag\n\n## 📋 Prerequisites\n\nAll dependencies are listed in `docs-requirements.txt`:\n\n```bash\npip install -r docs-requirements.txt\n```\n\nOr install individually:\n\n```bash\npip install mkdocs mkdocs-material pymdown-extensions\npip install mkdocs-awesome-pages-plugin\npip install mkdocs-git-revision-date-localized-plugin\npip install mike\n```\n\n## 🛠️ Local Development\n\n### Serve locally (with auto-reload)\n\n```bash\nmkdocs serve\n```\n\nAccess at: \u003chttp://127.0.0.1:8884\u003e\n\n### Build locally\n\n```bash\nmkdocs build --clean --verbose\n```\n\nOutput in `site/` directory\n\n## 📦 GitHub Pages Setup\n\n⚠️ **CRITICAL**: Change Source to \"GitHub Actions\" (not branch deployment!)\n\n### One-Time Setup\n\n1. Go to **Settings** \u003e **Pages** in your GitHub repository\n2. Under **Source**, select **\"GitHub Actions\"** (NOT \"Deploy from a branch\")\n3. Push to `main` branch or trigger workflow manually\n4. Check **Actions** tab for deployment status\n\n**Current Issue**: If set to \"Deploy from a branch\", the documentation won't build.\nSee `GITHUB_PAGES_FIX.md` for detailed instructions.\n\n## 📦 GitLab Pages Setup\n\nGitLab Pages deploys automatically via the `pages` job in `.gitlab-ci.yml`:\n\n1. Check **CI/CD** \u003e **Pipelines** for job status\n2. Go to **Settings** \u003e **Pages** to view your docs URL\n3. Configure access level (public/private) if needed\n\n## 🔧 Configuration Files\n\n- **mkdocs.yml** - MkDocs configuration\n- **docs-requirements.txt** - Python dependencies\n- **.github/workflows/deploy-docs.yml** - GitHub Actions workflow\n- **.gitlab-ci.yml** - GitLab CI/CD (includes `pages` job)\n\n## 🎨 Customization\n\n- **Content**: Edit Markdown files in `docs/`\n- **Theme**: Modify settings in `mkdocs.yml`\n- **Styling**: Custom CSS in `docs/assets/css/custom.css`\n- **Scripts**: Custom JS in `docs/assets/js/`\n\n## 🔍 Troubleshooting\n\n### GitHub Actions failing\n\n1. Check the **Actions** tab for error logs\n2. Verify all dependencies in `docs-requirements.txt` are compatible\n3. Ensure GitHub Pages is set to \"GitHub Actions\" as source\n4. Check workflow has proper permissions (pages: write, id-token: write)\n\n### GitLab Pages not deploying\n\n1. Check **CI/CD** \u003e **Pipelines** for the `pages` job status\n2. Verify the job creates a `public/` directory\n3. Check that `docs-requirements.txt` is present\n4. Review job logs for build errors\n\n### Build errors locally\n\n1. Update dependencies: `pip install -r docs-requirements.txt --upgrade`\n2. Clear cache: `rm -rf site/`\n3. Rebuild: `mkdocs build --clean --verbose`\n4. Check for broken links or missing pages\n\n### Missing plugins error\n\nIf you see errors about missing plugins, ensure all dependencies are installed:\n\n```bash\npip install -r docs-requirements.txt\n```\n\n## 📚 Resources\n\n- [MkDocs Documentation](https://www.mkdocs.org/)\n- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)\n- [GitHub Pages](https://docs.github.com/en/pages)\n- [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbvandewe%2Fevents-player","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbvandewe%2Fevents-player","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbvandewe%2Fevents-player/lists"}