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.

Sign up for GitHub

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

Jump to bottom

4.x: Externalize and compile documentation java snippets #8293

Closed
romain-grecourt opened this issue Jan 25, 2024 · 0 comments · Fixed by #8294
Closed

4.x: Externalize and compile documentation java snippets #8293

romain-grecourt opened this issue Jan 25, 2024 · 0 comments · Fixed by #8294
Assignees
@romain-grecourt
Labels
4.x Version 4.x docs
Milestone
4.1.0

Comments

@romain-grecourt
Copy link
Contributor

Environment Details

  • Helidon Version: 4.0.3, 3.2.5, 2.6.5, 1.4.14

Problem Description

Move all the java code snippets that are inlined inside .adoc files to java classes under src/main/java, and setup the compiler to compile the snippets.

There are some benefits:

  • Code snippets will be validated with compilation
  • Easier to enforce conventions for code snippets as they are grouped together
@romain-grecourt romain-grecourt added docs 4.x Version 4.x labels Jan 25, 2024
@romain-grecourt romain-grecourt added this to the 4.0.4 milestone Jan 25, 2024
@romain-grecourt romain-grecourt self-assigned this Jan 25, 2024
@romain-grecourt romain-grecourt changed the title Externalize and compile documentation java snippets 4.x: Externalize and compile documentation java snippets Jan 25, 2024
romain-grecourt added a commit to romain-grecourt/helidon that referenced this issue Jan 25, 2024
@romain-grecourt
4.x - Externalize and compile documentation java snippets - part 1
07acb1c 
Relates to helidon-io#8293

Only process a few files to start with:
- se/webclient.adoc
- se/webserver.adoc
- se/websocket.adoc
romain-grecourt added a commit to romain-grecourt/helidon that referenced this issue Jan 25, 2024
@romain-grecourt
4.x - Externalize and compile documentation java snippets - part 1
d5946e0 
Relates to helidon-io#8293

Only process a few files to start with:
- se/webclient.adoc
- se/webserver.adoc
- se/websocket.adoc
romain-grecourt added a commit to romain-grecourt/helidon that referenced this issue Jan 25, 2024
@romain-grecourt
4.x - Externalize and compile documentation java snippets - part 1
83d2831 
Relates to helidon-io#8293

Only process a few files to start with:
- se/webclient.adoc
- se/webserver.adoc
- se/websocket.adoc
@romain-grecourt romain-grecourt mentioned this issue Jan 25, 2024
Merged
@barchetta barchetta modified the milestones: 4.0.4, 4.1.0 Jan 26, 2024
romain-grecourt added a commit to romain-grecourt/helidon that referenced this issue Feb 13, 2024
@romain-grecourt
4.x - Externalize and compile documentation java snippets
1537c75 
Fixes helidon-io#8293
romain-grecourt added a commit to romain-grecourt/helidon that referenced this issue Feb 13, 2024
@romain-grecourt
4.x - Externalize and compile documentation java snippets
eac273c 
Fixes helidon-io#8293
@m0mus m0mus added this to Backlog Aug 12, 2024
@m0mus m0mus moved this to Closed in Backlog Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@romain-grecourt romain-grecourt

Labels
4.x Version 4.x docs
Projects
Backlog
Archived in project
Milestone
4.1.0
Development

Successfully merging a pull request may close this issue.

4.x - Externalize and compile documentation java snippets romain-grecourt/helidon
2 participants
@romain-grecourt @barchetta