{"id":15013754,"url":"https://github.com/amusarra/eventbus-logging-filter-jaxrs-docs","last_synced_at":"2025-04-12T05:45:48.454Z","repository":{"id":235825640,"uuid":"790354254","full_name":"amusarra/eventbus-logging-filter-jaxrs-docs","owner":"amusarra","description":"Doc-as-Code project for the eBook Quarkus Event Bus Logging Filter JAX-RS","archived":false,"fork":false,"pushed_at":"2024-07-18T21:25:34.000Z","size":9544,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T05:45:29.660Z","etag":null,"topics":["asciidoc","event-bus","java","jax-rs","quarkus"],"latest_commit_sha":null,"homepage":"https://amusarra.github.io/eventbus-logging-filter-jaxrs-docs/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/amusarra.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2024-04-22T18:17:08.000Z","updated_at":"2025-01-24T11:03:00.000Z","dependencies_parsed_at":"2024-04-29T11:55:09.876Z","dependency_job_id":null,"html_url":"https://github.com/amusarra/eventbus-logging-filter-jaxrs-docs","commit_stats":null,"previous_names":["amusarra/eventbus-logging-filter-jaxrs-docs"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amusarra%2Feventbus-logging-filter-jaxrs-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amusarra%2Feventbus-logging-filter-jaxrs-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amusarra%2Feventbus-logging-filter-jaxrs-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amusarra%2Feventbus-logging-filter-jaxrs-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amusarra","download_url":"https://codeload.github.com/amusarra/eventbus-logging-filter-jaxrs-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525154,"owners_count":21118616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["asciidoc","event-bus","java","jax-rs","quarkus"],"created_at":"2024-09-24T19:44:44.691Z","updated_at":"2025-04-12T05:45:48.414Z","avatar_url":"https://github.com/amusarra.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quarkus Event Bus Logging Filter JAX-RS Documentation\n\n[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md)\n[![License: MIT](https://img.shields.io/badge/license-CC--BY--NC--SA--4.0-lightgrey)](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.it)\n\n[![Maven AsciiDoc to PDF](https://github.com/amusarra/eventbus-logging-filter-jaxrs-docs/actions/workflows/build_asciidoc_to_pdf.yml/badge.svg)](https://github.com/amusarra/eventbus-logging-filter-jaxrs-docs/actions/workflows/build_asciidoc_to_pdf.yml)\n[![Deploy AsciiDocs Pages](https://github.com/amusarra/eventbus-logging-filter-jaxrs-docs/actions/workflows/build_asciidoc_to_html_github_page.yml/badge.svg)](https://github.com/amusarra/eventbus-logging-filter-jaxrs-docs/actions/workflows/build_asciidoc_to_html_github_page.yml)\n\nThe **Document as Code (doc-as-code)** approach applies software development principles to the creation, management, and distribution of documentation. This method aims to improve the quality, efficiency, and agility of documentation production by treating documents as part of the project’s source code.\n\nThis fosters a culture of documentation that is agilely integrated with software development, allowing for a more efficient workflow, higher quality documentation, and a better overall experience for developers and end users.\n\nThis repository contains the source code of the [Quarkus Event Bus Logging Filter JAX-RS](https://github.com/amusarra/eventbus-logging-filter-jaxrs) eBook, illustrating how the project was created and published on GitHub.\n\nThe project was developed using the Document as Code (doc-as-code) approach, using [AsciiDoc](https://asciidoc.org/), a lightweight markup language for writing human-readable and machine-readable documents.\n\nThe toolchain used for generating the eBook is [Asciidoctor](https://asciidoctor.org/), a text processor supporting AsciiDoc syntax that produces HTML5, DocBook, PDF, and other formats.\n\nSupported outputs for this documentation are: html5 and pdf.\n\nThe project uses the [Asciidoctor](https://asciidoctor.org/docs/asciidoctor-maven-plugin/) Maven Plugin, responsible for processing source files in AsciiDoc format and generating the eBook in PDF format.\n\n## Requirements\nTo generate documentation in the supported formats, the following software needs to be installed on your system (development workstation or CI/CD):\n\n- Java JDK 11 or higher\n- Maven 3.8.x or higher\n- Mermaid CLI 10.8.4 or higher\n\n[Mermaid CLI](https://www.npmjs.com/package/@mermaid-js/mermaid-cli?activeTab=readme) is a tool for generating flowcharts, sequence diagrams, Gantt charts, and class diagrams from source code; some diagrams in the documentation are generated using Mermaid.\n\n\nInstall this tool via the npm package manager, requiring Node.js (version ^14.13 || \u003e=16.0).\n\n```shell script\nnpm install -g @mermaid-js/mermaid-cli\n```\nConsole 0 - Install Mermaid CLI\n\n\n## Generating the eBook\nTo generate the eBook in PDF format, run the Maven command:\n\n```shell script\nmvn clean asciidoctor:process-asciidoc@asciidoc-to-pdf\n```\nConsole 1 - Execute the Maven command to generate the eBook\n\nThe Maven command will compile the project and generate the PDF eBook. The generated PDF file will be available in the project’s `target/generated-pdf` folder, named `${project.artifactId}-${project.version}.pdf`.\n\n## Generating HTML Documentation\nTo generate HTML documentation, run the Maven command:\n\n```shell script\nmvn clean asciidoctor:process-asciidoc@asciidoc-to-html\n```\nConsole 2 - Execute the Maven command to generate the HTML docs\n\nThe Maven command will compile the project and generate the HTML documentation. The HTML documentation will be available in the project’s `target/generated-html5` folder.\n\n## Publishing HTML Documentation on GitHub Pages\nThe generated HTML documentation is also available on [GitHub Pages](https://amusarra.github.io/eventbus-logging-filter-jaxrs-docs/). This is made possible by the GitHub Actions [Deploy AsciiDoc to Pages](.github/workflows/build_asciidoc_to_html_github_page.yml), which publishes the generated HTML documentation (via the AsciiDoc Maven plugin) to GitHub Pages.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famusarra%2Feventbus-logging-filter-jaxrs-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famusarra%2Feventbus-logging-filter-jaxrs-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famusarra%2Feventbus-logging-filter-jaxrs-docs/lists"}