docs: Introduce initial docs for service module (Preview)#2350
docs: Introduce initial docs for service module (Preview)#2350TomCools wants to merge 12 commits into
Conversation
TomCools
had a problem deploying
to
documentation (preview)
GitHub Actions
Failure
triceo
left a comment
triceo
left a comment
There was a problem hiding this comment.
Some notes after a first quick look.
| :sectnums: | ||
| :icons: font | ||
| :relevance: both | ||
| :notes: Relevant, needs some rewrites. Also should include the "Getting Started" for Quarkus (raw) and Spring |
There was a problem hiding this comment.
Is this a third thing? "core", "service" and "raw"?
There was a problem hiding this comment.
raw => Core + Quarkus plugin integration. That should be clarified. It's the weird double right now.
| @@ -0,0 +1,28 @@ | |||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |||
There was a problem hiding this comment.
I never much liked copy-pasting stuff from production code. Gets quickly outdated and forgotten about, until some user points it out.
Any chance we could have a live mechanism to point to an authoritative piece of source code, such as one in the quickstarts repo?
There was a problem hiding this comment.
Under investigation ;) We have a similar problem for all of the quickstarts btw.
|
|
||
| * **Knowledge** | ||
| ** Java (Basic) | ||
| ** Quarkus (Basic) |
There was a problem hiding this comment.
This is IMO where you immediately lose Spring people.
We can only keep Spring people if we treat the service as a black box that uses no technology which the user needs to care about.
There was a problem hiding this comment.
Q: What is the exact quarkus knowledge that is needed?
There was a problem hiding this comment.
Until we fully abstract Quarkus away and it is a black box, the reference should stay. It's just being up-front of what is needed.
| Open the http://localhost:8080/q/swagger-ui/[Swagger OpenAPI Viewer] to inspect the generated API Endpoints: | ||
| http://localhost:8080/q/swagger-ui/ | ||
|
|
||
| image:quickstart/mdk/openapi.png[Screenshot of the Swagger OpenAPI UI showing the automatically generated REST API endpoints] |
There was a problem hiding this comment.
Folder name "mdk" to be updated?
| :sectnums: | ||
| :icons: font | ||
|
|
||
| :relevance: both |
There was a problem hiding this comment.
:relevance: is just something internal? an annotation? or does it trigger something automatically?
There was a problem hiding this comment.
Doesn't trigger anything, just metadata for me while refactoring the docs, so i don't have to keep a separate file with this info.
|
|
||
| include::_preview-note.adoc[] | ||
|
|
||
| Run optimization as a fully isolated service. |
There was a problem hiding this comment.
PP: Dataset optimization
| "name": "run name", | ||
| "termination": { | ||
| "spentLimit": "PT5M", | ||
| "unimprovedSpentLimit": "PT10S" |
There was a problem hiding this comment.
Q: There probably are more terminations now? stepCount?
There was a problem hiding this comment.
I will make an issue to tackle this. Describing the terminations would be a new section.
#2359
TomCools
had a problem deploying
to
documentation (preview)
GitHub Actions
Failure
External loading doesn't work in Antora, at least not close to the source.
TomCools
changed the title
|
3 participants
Currently providing this PR in DRAFT as a preview of the changes to come. Some content still needs validation and review from my side: e.g. going through the quickstart guide myself again and updating some references, after the service module has been officially released.
We have introduced the "Service" module, but this did not contain any documentation yet.
This PR will: