Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
51 changes: 51 additions & 0 deletions .devcontainer/.devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/java
{
"name": "Microprofile",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/java:1-17-bookworm",

"features": {
"ghcr.io/devcontainers/features/java:1": {
"installMaven": true,
"version": "17",
"jdkDistro": "ms",
"gradleVersion": "latest",
"mavenVersion": "latest",
"antVersion": "latest",
"groovyVersion": "latest"
},
"ghcr.io/ebaskoro/devcontainer-features/sdkman:1": {
"candidate": "java",
"version": "latest"
},
"ghcr.io/devcontainers/features/docker-in-docker:2": {
"moby": true,
"azureDnsAutoDetection": true,
"installDockerBuildx": true,
"installDockerComposeSwitch": true,
"version": "latest",
"dockerDashComposeVersion": "none"
}
},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "java -version",

// Configure tool-specific properties.
"customizations": {
"vscode": {
"extensions": [
"vscjava.vscode-java-pack",
"github.copilot",
"microprofile-community.vscode-microprofile-pack"
]
}
}

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
5 changes: 4 additions & 1 deletion .github/workflows/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@ jobs:
- name: Install Antora
run: npm install -g @antora/cli @antora/site-generator-default

- name: Verify Antora Installation
run: npm list -g @antora/cli @antora/site-generator-default || echo "Antora packages are not installed."

- name: Generate Site with Antora
run: antora --fetch playbook.yml
run: antora --fetch --stacktrace playbook.yml

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
Expand Down
72 changes: 72 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,73 @@
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
replay_pid*

# Maven
log/
target/
release/
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties

# Gradle
.gradle/
build/
!gradle/wrapper/gradle-wrapper.jar

# Eclipse
.classpath
.project
.settings/

# IntelliJ
*.iml
.idea/
out/

# VS Code
.vscode/

# OS Files
.DS_Store
Thumbs.db

# Others
*.mf
*.swp
*.cs
*~

# Liberty
wlp/usr/servers/*/logs/
wlp/usr/servers/*/workarea/
wlp/usr/servers/*/dropins/
wlp/usr/servers/*/apps/
wlp/usr/servers/*/configDropins/

# Specific project directories
liberty-rest-app/target/
mp-ecomm-store/target/

/node_modules/
23 changes: 13 additions & 10 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ content:
----
ui:
bundle:
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
snapshot: true
supplemental_files: ./supplemental-ui
----
Expand All @@ -177,7 +177,7 @@ The `antora.yml` file defines the documentation component:
name: microprofile-tutorial
title: MicroProfile Tutorial
version: 6.1
edit_url: https://github.com/ttelang/microprofile-tutorial/edit/patch-15/modules/ROOT/pages/{path}
edit_url: https://github.com/microprofile/microprofile-tutorial/tree/main/modules/ROOT/pages/{path}
asciidoc:
attributes:
source-language: asciidoc@
Expand Down Expand Up @@ -291,7 +291,7 @@ The `fix-edit-links.sh` script is a necessary post-processing step in the build

The script performs a simple text replacement in the generated HTML files, replacing local file paths with proper GitHub repository URLs. This ensures that the "Edit this Page" links work correctly for users viewing the documentation.

If you update the repository URL or branch name, make sure to update the replacement URL in the `fix-edit-links.sh` script accordingly. The current implementation assumes the GitHub repository URL is `https://github.com/ttelang/microprofile-tutorial` and the branch is `patch-15`.
If you update the repository URL or branch name, make sure to update the replacement URL in the `fix-edit-links.sh` script accordingly. The current implementation assumes the GitHub repository URL is `https://github.com/microprofile/microprofile-tutorial` and the branch is `main`.

## Automating Repository URL Configuration

Expand Down Expand Up @@ -569,7 +569,7 @@ The MicroProfile Tutorial uses a customized UI bundle from the `microprofile-doc
----
ui:
bundle:
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/tag/latest/ui-bundle.zip
snapshot: true
supplemental_files: ./supplemental-ui
----
Expand Down Expand Up @@ -620,15 +620,15 @@ To update to a newer version of the UI bundle:
----
ui:
bundle:
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/tag/latest/ui-bundle.zip
snapshot: true
----

#### Creating a Custom UI Bundle

If you need extensive customization beyond what supplemental files allow:

1. Fork the https://github.com/ttelang/microprofile-documentation-ui repository
1. Fork the https://github.com/microprofile/microprofile-tutorial-ui repository
2. Make your customizations following the project's README
3. Build the UI bundle using `gulp bundle`
4. Host the resulting ZIP file (e.g., on GitHub Releases)
Expand All @@ -648,7 +648,7 @@ You can control how Antora handles UI bundle caching:
----
ui:
bundle:
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
snapshot: true # Always fetch the latest version
# snapshot: false # Use cached version when available
----
Expand All @@ -665,7 +665,7 @@ Modern UI bundles for Antora can include advanced features:
----
ui:
bundle:
url: https://example.com/ui-bundle.zip
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
supplemental_files: ./supplemental-ui
search:
engine: lunr # Or another search engine
Expand All @@ -678,7 +678,7 @@ search:
----
ui:
bundle:
url: https://example.com/ui-bundle.zip
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
output:
dir: ./build/site
formats:
Expand Down Expand Up @@ -710,6 +710,8 @@ ui:
snapshot: true
----

Replease _./path/to/local/ui-bundle.zip_ with actual path to your local UI bundle under development.

This approach is useful when developing your own UI bundle or testing modifications.

### UI Bundle Development
Expand Down Expand Up @@ -742,4 +744,5 @@ When troubleshooting UI problems:
1. Use browser developer tools to inspect elements and styles
2. Check the browser console for JavaScript errors
3. Verify that all required resources are loading correctly
4. Test with different browsers to identify browser-specific issues
4. Test with different browsers to identify browser-specific issues

2 changes: 1 addition & 1 deletion antora-assembler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ content:

ui:
bundle:
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
snapshot: true
supplemental_files: ./supplemental-ui

Expand Down
2 changes: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: microprofile-tutorial
title: MicroProfile Tutorial
version: 6.1
edit_url: https://github.com/ttelang/microprofile-tutorial/edit/patch-15/modules/ROOT/pages/{path}
edit_url: https://github.com/microprofile/microprofile-tutorial/tree/main/modules/ROOT/pages/{path}
asciidoc:
attributes:
source-language: asciidoc@
Expand Down
2 changes: 1 addition & 1 deletion build/site/microprofile-tutorial/6.1/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h3 class="title"><a href="index.html">MicroProfile Tutorial</a></h3>
<li><a href="README.html">README</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/ttelang/microprofile-tutorial/edit/patch-15/modules/ROOT/pages/README.adoc">Edit this Page</a></div>
<div class="edit-this-page"><a href="https://github.com/microprofile/microprofile-tutorial/edit/main/modules/ROOT/pages/README.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
Expand Down
Loading