Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/insert af reference guide #3019

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

pckuyer
Copy link
Contributor

@pckuyer pckuyer commented May 6, 2024

The axon framework documentation was rewritten from .md to .adoc and will be part of the framework repo from now on.

smcvb and others added 15 commits February 23, 2024 18:19
Copy RefGuide into docs folder and convert to asciidoc. Besides the copy
 and the conversion, the base files and "axon-framework-commands" files
 should be checked for their structure and links. The rest will follow
 at a later stage.

#feature/insert-af-reference-guide
Validate and fix deadline chapter

#feature/insert-af-reference-guide
Validate and fix event processor chapter

#feature/insert-af-reference-guide
Validate and fix event chapter

#feature/insert-af-reference-guide
Validate and fix messaging-concepts chapter

#feature/insert-af-reference-guide
Validate and fix monitoring chapter

#feature/insert-af-reference-guide
Copy link
Member

@gklijs gklijs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went through it quickly. While I see a lot of things we could improve on eventually, like using code from the repository instead of directly in the docs, this is something we can do later. I also left one suggestion, as this was outdated information based on how jobrunr supports both Spring Boot 2 and 3.

docs/reference/framework/deadlines/deadline-managers.adoc Outdated Show resolved Hide resolved
@gklijs gklijs requested a review from dgomezg May 8, 2024 11:44
Copy link
Contributor

@dgomezg dgomezg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assets folder inside docs is misplaced and impeding antora to build the docs.

Any folder inside docs except those starting with underscore (_) will be considered by antora build process as a doc module and, consequently, will require an antora.yml descriptor file.

In this case, the aforementioned folder seem to contain images. If those are used from the docs, they should be better placed in an images subfolder of the specific doc module that is using it.

(see https://github.com/AxonIQ/console-web/tree/main/docs/ac-getting-started/modules/ac-gs-setup/images and how they are used from https://github.com/AxonIQ/console-web/blob/main/docs/ac-getting-started/modules/ac-gs-setup/pages/access.adoc

Co-authored-by: Gerard Klijs <gerard.klijs@axoniq.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants