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

Refactor the documentation so we can list all the available sections #402

Open
agoncal opened this issue Oct 12, 2023 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@agoncal
Copy link
Collaborator

agoncal commented Oct 12, 2023

Today in the "How Does This Workshop Work?" section, we explain the structure of the workshop:

The structure of this workshop is as follows:

  • Installing all the needed tools:
    in this section, you will install all the tools and code to be able to develop, compile and execute our application
  • Developing microservices with Quarkus:
    in this section, you will develop a microservice architecture by creating several Maven projects, write some Java code, add JPA entities, JAX-RS REST endpoints, write some tests, use an Angular web application, and all that on Quarkus
    ifdef::use-ai[]
  • Artificial Intelligence:
    in this section, you will use OpenAI or Azure OpenAI to invoke an AI so you can generate a random narration of the fight
    endif::use-ai[]

It would be nice if we actually list all the section of workshop using the xref syntax in Asciidoc (eg. xref:azure.adoc#azure[xrefstyle=full])

The structure of this workshop is as follows:

  • xref:installing.adoc#installing[xrefstyle=full]:
    in this section, you will install all the tools and code to be able to develop, compile and execute our application
  • xref:developping.adoc#developping[xrefstyle=full]:
    in this section, you will develop a microservice architecture by creating several Maven projects, write some Java code, add JPA entities, JAX-RS REST endpoints, write some tests, use an Angular web application, and all that on Quarkus
    ifdef::use-ai[]
  • xref:ai.adoc#ai[xrefstyle=full]:
    in this section, you will use OpenAI or Azure OpenAI to invoke an AI so you can generate a random narration of the fight
    endif::use-ai[]
@agoncal agoncal added the documentation Improvements or additions to documentation label Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant