Add doc sources for Java SDK from main docs#70
Conversation
ennru
left a comment
ennru
left a comment
There was a problem hiding this comment.
Looks good.
I believe duplicating the partials can be a price we can afford.
| * In a `settings.xml` file located in your home directory in a sub-directory named `.m2`. If you have an existing `settings.xml` file, either in your home directory or in `\{MAVEN_HOME}/conf`, add the `akkaserverless` profile element shown in the full example below and list it as `activeProfile` in the existing file. | ||
| * Your organization may have configured a proxy to be used to download Maven artifacts, such as Jfrog Artifactory. If you have difficulties updating `settings.xml` for a proxy, please consult your system administrator. | ||
|
|
||
| The following shows a complete `settings.xml` file configured to use the Lightbend repository: | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| include::example$settings.xml[] | ||
| ---- |
There was a problem hiding this comment.
If #72 gets merged first, we can already remove that section from the docs.
There was a problem hiding this comment.
Sounds good. We'll end up publishing these docs to make the switch over to the sources being here, so we may want to release the new archetypes first.
| [source,command window, subs="attributes"] | ||
| ---- | ||
| mvn archetype:generate \ | ||
| -DarchetypeGroupId=com.lightbend \ | ||
| -DarchetypeArtifactId=maven-archetype-akkasls \ | ||
| -DarchetypeVersion=LATEST | ||
| ---- | ||
| -- | ||
| Windows 10+:: | ||
| + | ||
| -- | ||
| [source,command window, subs="attributes"] | ||
| ---- | ||
| mvn archetype:generate ^ | ||
| -DarchetypeGroupId=com.lightbend ^ | ||
| -DarchetypeArtifactId=maven-archetype-akkasls ^ | ||
| -DarchetypeVersion=LATEST |
There was a problem hiding this comment.
Similar, if #72 gets merged first, we can update the groupId and artifactId
And we can still leave them as partials if we want, to make updating them across repos easier. |
|
To be able to make the switch to the doc sources being here, I'll first publish these under a different branch |
|
Published these sources to |
|
Will merge this now, and go through with the switch. |
3 participants
Copy the Java SDK docs from the main Akka Serverless docs, so they can be maintained here.
The partials from the developing module are still partials here (but under java module so they don't conflict), in case we want to move these to a common repo for all SDK docs later on.
Cross-references to the main docs are all converted to external links to the published production docs, so the docs here can be used and checked separately. These are full links in the asciidoc sources, so they get validated by the asciidoc external link checker, which doesn't support variables.
There's a simple setup for building and viewing the docs locally — uses a default theme, as the Akka Serverless doc theme is defined as supplemental ui in a private repo currently.
Kept as separate commits in this PR, in case we want to make any changes to the setup before merging.
Note: need to coordinate with removing these sources in the main docs, otherwise there will be conflicts with duplicate files, so marking this as draft.