diff --git a/.devcontainer/.devcontainer.json b/.devcontainer/.devcontainer.json new file mode 100644 index 00000000..e92ed3ba --- /dev/null +++ b/.devcontainer/.devcontainer.json @@ -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" +} diff --git a/.github/workflows/antora.yml b/.github/workflows/antora.yml index 2802f0e6..e70fce90 100644 --- a/.github/workflows/antora.yml +++ b/.github/workflows/antora.yml @@ -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 diff --git a/.gitignore b/.gitignore index 096746c1..329afec1 100644 --- a/.gitignore +++ b/.gitignore @@ -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/ \ No newline at end of file diff --git a/README.adoc b/README.adoc index e41e8bf8..100d57dc 100644 --- a/README.adoc +++ b/README.adoc @@ -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 ---- @@ -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@ @@ -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 @@ -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 ---- @@ -620,7 +620,7 @@ 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 ---- @@ -628,7 +628,7 @@ ui: 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) @@ -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 ---- @@ -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 @@ -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: @@ -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 @@ -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 \ No newline at end of file +4. Test with different browsers to identify browser-specific issues + diff --git a/antora-assembler.yml b/antora-assembler.yml index a48cd72a..1fe8f5cb 100644 --- a/antora-assembler.yml +++ b/antora-assembler.yml @@ -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 diff --git a/antora.yml b/antora.yml index 250d330e..2a39e118 100644 --- a/antora.yml +++ b/antora.yml @@ -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@ diff --git a/build/site/microprofile-tutorial/6.1/README.html b/build/site/microprofile-tutorial/6.1/README.html index 14657cda..7d30c33e 100644 --- a/build/site/microprofile-tutorial/6.1/README.html +++ b/build/site/microprofile-tutorial/6.1/README.html @@ -138,7 +138,7 @@

MicroProfile Tutorial

  • README
  • -
    Edit this Page
    +
    Edit this Page