Skip to content

Commit 2b64e7b

Browse files
ttelangEmily-Jiang
andauthored
Publishing MicroProfile Tutorial with Antora Site Generator (#28)
* Update index.adoc * Create README.md * Add files via upload * Rename MicroProfile e-Commerce Application.drawio.png to FigureFM-1.png * Rename FigureFM-1.png to figureFM-1.png * Update index.adoc * Adding Mindmap image Uploading Mindmap image for MicroProfile Architecture Philosophy * Create chapter01/chapter01.adoc Adding content for Chapter01 - Introduction to MicroProfile * Update chapter01.adoc Incorporating feedbacks about MicroProfile History from @aeiras * Update chapter01/chapter01.adoc Updating MPWG members * Update chapter01.adoc Need for MicroProfile * Update chapter01.adoc MicroProfile Platform Component Specifications * Update chapter01.adoc Standalone (Outside Umbrella) Specifications * Update chapter01.adoc Standalone (Outside Umbrella) Specifications * Update chapter01.adoc MicroProfile Implementations * Update chapter01.adoc Architecture Philosophy * Update chapter01.adoc Relationship with Jakarta EE specification * Fix for #5 (comment) * Fix for #5 (comment), #5 (comment) * Fix for #5 (comment) * Fix for #5 (comment) * Fix for #5 (comment) * Fix for #5 (comment) * Update index.adoc Co-authored-by: Emily Jiang <[email protected]> * Update index.adoc Co-authored-by: Emily Jiang <[email protected]> * Create chapter02.adoc * Build Tools - Update chapter02.adoc Build Tools * Update chapter02.adoc Setting up your IDE - part 1 * Update chapter02.adoc IDE * Update chapter02.adoc * Update chapter02.adoc IDEs * Update chapter02.adoc Setting up MicroProfile Runtime * Update chapter02.adoc MicroProfile Starter * Update chapter02.adoc MicroProfile Starter * Update chapter02.adoc MP Starter * Create chapter02-01.adoc - Creating a Java Project for MicroProfile Development Chapter02-01 * Update chapter02-01.adoc * Create chapter02-02.adoc * Update chapter02-02.adoc Choosing the Right MicroProfile Module for your Applications * Update chapter02-02.adoc * Create chapter02-03.adoc Developing RESTful Web Services * Update chapter02-03.adoc * Update chapter02-03.adoc * Create chapter02-05.adoc * Create chapter02-06.adoc - Glossary Glossary * Create chatper02-04.adoc * Rename chapter02.adoc to chapter02-00.adoc * Update chapter02-02.adoc * Update chapter02-00.adoc * Update chapter02-00.adoc * Update chapter02-01.adoc * Update chapter02-02.adoc * Update chatper02-04.adoc Testing your microservice * Update chapter02-03.adoc * Update chatper02-04.adoc * Update chatper02-04.adoc * Add files via upload * Delete images/MicroProfile e-Commerce Application.drawio.png * Delete images/figureFM-1.png * Delete images/FM-1 MicroProfile e-Commerce Application.drawio * Add files via upload * Rename MicroProfile e-Commerce Application.drawio (1).png to figureFM-1.png * Add files via upload * Update index.adoc * Create antora.yml * Create playbook.yml * Create antora.yml to configure the tutorial site * Create nav.adoc Creating nav.doc file with full paths in navigation * Create site.yml for GitLab-Hosted UI Bundle * Update navigation structure in nav.adoc * Update navigation structure in nav.adoc * Update navigation structure in nav.adoc * Update site.yml * Renaming chapter08 * Changes to be committed: new file: .devcontainer/devcontainer.json modified: nav.adoc modified: site.yml * Changes to be committed: modified: site.yml * Update antora.yml to include start_path for module resolution * Changes to be committed: modified: antora.yml modified: nav.adoc modified: site.yml * Changes to be committed: modified: antora.yml modified: index.adoc modified: site.yml * Changes to be committed: modified: site.yml Changes not staged for commit: deleted: chatper08/chapter08.adoc * Changes to be committed: modified: antora.yml Changes not staged for commit: deleted: chatper08/chapter08.adoc * Changes to be committed: modified: nav.adoc modified: site.yml * Changes to be committed: modified: site.yml * Changes to be committed: deleted: antora.yml * Changes to be committed: deleted: chatper08/chapter08.adoc * Changes to be committed: new file: antora.yml modified: nav.adoc modified: site.yml * Changes to be committed: modified: antora.yml new file: build/site/404.html new file: build/site/_/css/site.css new file: build/site/_/font/roboto-cyrillic-400-italic.woff2 new file: build/site/_/font/roboto-cyrillic-400-normal.woff2 new file: build/site/_/font/roboto-cyrillic-500-italic.woff2 new file: build/site/_/font/roboto-cyrillic-500-normal.woff2 new file: build/site/_/font/roboto-latin-400-italic.woff new file: build/site/_/font/roboto-latin-400-italic.woff2 new file: build/site/_/font/roboto-latin-400-normal.woff new file: build/site/_/font/roboto-latin-400-normal.woff2 new file: build/site/_/font/roboto-latin-500-italic.woff new file: build/site/_/font/roboto-latin-500-italic.woff2 new file: build/site/_/font/roboto-latin-500-normal.woff new file: build/site/_/font/roboto-latin-500-normal.woff2 new file: build/site/_/font/roboto-mono-latin-400-normal.woff new file: build/site/_/font/roboto-mono-latin-400-normal.woff2 new file: build/site/_/font/roboto-mono-latin-500-normal.woff new file: build/site/_/font/roboto-mono-latin-500-normal.woff2 new file: build/site/_/img/back.svg new file: build/site/_/img/caret.svg new file: build/site/_/img/chevron.svg new file: build/site/_/img/home-o.svg new file: build/site/_/img/home.svg new file: build/site/_/img/menu.svg new file: build/site/_/img/octicons-16.svg new file: build/site/_/js/site.js new file: build/site/_/js/vendor/highlight.js renamed: images/figure1-2.png -> modules/ROOT/assets/figure1-2.png renamed: images/figure4-1.png -> modules/ROOT/assets/figure4-1.png renamed: images/figure8-1.png -> modules/ROOT/assets/figure8-1.png renamed: images/figureFM-1.png -> modules/ROOT/assets/figureFM-1.png renamed: images/src/figure1-2 MP_Arch_Philosophy.drawio -> modules/ROOT/assets/src/figure1-2 MP_Arch_Philosophy.drawio renamed: images/src/figureFM-1.drawio -> modules/ROOT/assets/src/figureFM-1.drawio renamed: README.adoc -> modules/ROOT/pages/README.adoc renamed: chapter01/chapter01.adoc -> modules/ROOT/pages/chapter01/chapter01.adoc renamed: chapter02/chapter02-00.adoc -> modules/ROOT/pages/chapter02/chapter02-00.adoc renamed: chapter02/chapter02-01.adoc -> modules/ROOT/pages/chapter02/chapter02-01.adoc renamed: chapter02/chapter02-02.adoc -> modules/ROOT/pages/chapter02/chapter02-02.adoc renamed: chapter02/chapter02-03.adoc -> modules/ROOT/pages/chapter02/chapter02-03.adoc renamed: chapter02/chapter02-04.adoc -> modules/ROOT/pages/chapter02/chapter02-04.adoc renamed: chapter02/chapter02-05.adoc -> modules/ROOT/pages/chapter02/chapter02-05.adoc renamed: chapter02/chapter02-06.adoc -> modules/ROOT/pages/chapter02/chapter02-06.adoc renamed: chapter03/chapter03.adoc -> modules/ROOT/pages/chapter03/chapter03.adoc renamed: chapter04/chapter04.adoc -> modules/ROOT/pages/chapter04/chapter04.adoc renamed: chapter05/chapter05.adoc -> modules/ROOT/pages/chapter05/chapter05.adoc renamed: chapter06/chapter06.adoc -> modules/ROOT/pages/chapter06/chapter06.adoc renamed: chapter07/chapter07.adoc -> modules/ROOT/pages/chapter07/chapter07.adoc renamed: chapter08/chapter08.adoc -> modules/ROOT/pages/chapter08/chapter08.adoc new file: modules/ROOT/pages/chapter08_file.bak renamed: chapter09/index.adoc -> modules/ROOT/pages/chapter09/index.adoc renamed: index.adoc -> modules/ROOT/pages/index.adoc new file: modules/ROOT/pages/nav.adoc deleted: nav.adoc modified: site.yml * Changes to be committed: modified: modules/ROOT/pages/README.adoc modified: modules/ROOT/pages/chapter01/chapter01.adoc modified: modules/ROOT/pages/chapter04/chapter04.adoc modified: modules/ROOT/pages/chapter08/chapter08.adoc modified: modules/ROOT/pages/index.adoc modified: site.yml * Changes to be committed: modified: modules/ROOT/pages/chapter01/chapter01.adoc modified: site.yml Changes not staged for commit: modified: modules/ROOT/pages/chapter08/chapter08.adoc * Changes to be committed: modified: modules/ROOT/pages/chapter08/chapter08.adoc * Changes to be committed: modified: antora.yml new file: build/site/microprofile-tutorial/latest/README.html renamed: modules/ROOT/assets/figure1-2.png -> build/site/microprofile-tutorial/latest/_images/figure1-2.png renamed: modules/ROOT/assets/figure4-1.png -> build/site/microprofile-tutorial/latest/_images/figure4-1.png renamed: modules/ROOT/assets/figure8-1.png -> build/site/microprofile-tutorial/latest/_images/figure8-1.png renamed: modules/ROOT/assets/figureFM-1.png -> build/site/microprofile-tutorial/latest/_images/figureFM-1.png new file: build/site/microprofile-tutorial/latest/chapter01/chapter01.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02-00.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02-01.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02-02.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02-03.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02-04.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02-05.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02-06.html new file: build/site/microprofile-tutorial/latest/chapter03/chapter03.html new file: build/site/microprofile-tutorial/latest/chapter04/chapter04.html new file: build/site/microprofile-tutorial/latest/chapter05/chapter05.html new file: build/site/microprofile-tutorial/latest/chapter06/chapter06.html new file: build/site/microprofile-tutorial/latest/chapter07/chapter07.html new file: build/site/microprofile-tutorial/latest/chapter08/chapter08.html new file: build/site/microprofile-tutorial/latest/chapter09/index.html new file: build/site/microprofile-tutorial/latest/index.html new file: build/site/microprofile-tutorial/latest/nav.html new file: modules/ROOT/images/figure1-2.png new file: modules/ROOT/images/figure4-1.png new file: modules/ROOT/images/figure8-1.png new file: modules/ROOT/images/figureFM-1.png modified: modules/ROOT/pages/README.adoc modified: site.yml * Changes to be committed: modified: antora.yml modified: build/site/microprofile-tutorial/latest/README.html modified: build/site/microprofile-tutorial/latest/chapter01/chapter01.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-00.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-01.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-02.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-03.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-04.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-05.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-06.html modified: build/site/microprofile-tutorial/latest/chapter03/chapter03.html modified: build/site/microprofile-tutorial/latest/chapter04/chapter04.html modified: build/site/microprofile-tutorial/latest/chapter05/chapter05.html modified: build/site/microprofile-tutorial/latest/chapter06/chapter06.html modified: build/site/microprofile-tutorial/latest/chapter07/chapter07.html modified: build/site/microprofile-tutorial/latest/chapter08/chapter08.html modified: build/site/microprofile-tutorial/latest/chapter09/index.html modified: build/site/microprofile-tutorial/latest/index.html modified: modules/ROOT/pages/chapter02/chapter02-04.adoc modified: modules/ROOT/pages/chapter03/chapter03.adoc modified: site.yml * Changes to be committed: modified: antora.yml modified: modules/ROOT/pages/chapter03/chapter03.adoc modified: site.yml * Changes to be committed: new file: build/site/index.html modified: build/site/microprofile-tutorial/latest/README.html modified: build/site/microprofile-tutorial/latest/chapter01/chapter01.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-00.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-01.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-02.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-03.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-04.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-05.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-06.html modified: build/site/microprofile-tutorial/latest/chapter03/chapter03.html modified: build/site/microprofile-tutorial/latest/chapter04/chapter04.html modified: build/site/microprofile-tutorial/latest/chapter05/chapter05.html modified: build/site/microprofile-tutorial/latest/chapter06/chapter06.html modified: build/site/microprofile-tutorial/latest/chapter07/chapter07.html modified: build/site/microprofile-tutorial/latest/chapter08/chapter08.html modified: build/site/microprofile-tutorial/latest/chapter09/index.html modified: build/site/microprofile-tutorial/latest/index.html * Changes to be committed: modified: build/site/microprofile-tutorial/latest/chapter08/chapter08.html new file: index.adoc new file: minimal-component/antora.yml modified: modules/ROOT/pages/chapter08/chapter08.adoc new file: nav.adoc * Changes to be committed: modified: build/site/microprofile-tutorial/latest/README.html modified: build/site/microprofile-tutorial/latest/chapter01/chapter01.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-00.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-01.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-02.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-03.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-04.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-05.html modified: build/site/microprofile-tutorial/latest/chapter02/chapter02-06.html new file: build/site/microprofile-tutorial/latest/chapter02/chapter02.html modified: build/site/microprofile-tutorial/latest/chapter03/chapter03.html modified: build/site/microprofile-tutorial/latest/chapter04/chapter04.html modified: build/site/microprofile-tutorial/latest/chapter05/chapter05.html modified: build/site/microprofile-tutorial/latest/chapter06/chapter06.html modified: build/site/microprofile-tutorial/latest/chapter07/chapter07.html modified: build/site/microprofile-tutorial/latest/chapter08/chapter08.html modified: build/site/microprofile-tutorial/latest/chapter09/index.html new file: build/site/microprofile-tutorial/latest/chapter10/chapter10.html new file: build/site/microprofile-tutorial/latest/chapter11/chapter11.html modified: build/site/microprofile-tutorial/latest/index.html new file: modules/ROOT/pages/chapter02/chapter02.adoc deleted: modules/ROOT/pages/chapter08_file.bak new file: modules/ROOT/pages/chapter10/chapter10.adoc new file: modules/ROOT/pages/chapter11/chapter11.adoc modified: modules/ROOT/pages/nav.adoc modified: nav.adoc * Changes to be committed: new file: antora-assembler.yml modified: antora.yml deleted: nav.adoc new file: package.json modified: site.yml * Update site configuration for MicroProfile tutorial * adding site content and enhance documentation for multiple chapters - Created a new sitemap.xml file for improved site navigation and SEO. - Updated README.adoc to include instructions for running the site locally. - Standardized chapter headings in chapter03.adoc and chapter04.adoc for consistency. - Enhanced content in chapter06.adoc, chapter07.adoc, chapter10.adoc, and chapter11.adoc with clearer headings and improved structure. - Updated navigation links in nav.adoc for better clarity and organization. * Update chapter11.adoc * Update chapter10.adoc * Update index.adoc grammar and styling fixes to index.adoc (Front matter of this Tutorial) * Update chapter02-01.adoc Minor formatting changes * Update chapter02-00.adoc * Update chapter01.adoc Removing `Chapter 1` from title * Update chapter02-03.adoc Minor formating changes * Update chapter02-04.adoc * Update chapter02-05.adoc * Update chapter03.adoc - Minor formatting changs * Update chapter02-01.adoc * Update chapter02-03.adoc * Update chapter02-05.adoc renaming product-catalog * Update chapter03.adoc * Update chapter04.adoc Minor grammatically and formatting changes. * Update chapter04.adoc Minor grammatical and formatting fixes. * Update sitemap.xml and site.yml for latest content and UI bundle URL - Updated last modification dates in sitemap.xml to reflect new content updates. - Changed the UI bundle URL in site.yml to point to the correct repository for the latest release. * Update sitemap and add development scripts - Updated last modified dates in sitemap.xml for all tutorial chapters to reflect recent changes. - Added dev-server.sh script for building and serving the MicroProfile Tutorial documentation with automatic rebuilding on file changes. - Introduced fix-edit-links.sh script to replace local file links with GitHub repository links in generated HTML files. - Added favicon images (PNG and SVG) for the tutorial site. - Updated chapter titles in various AsciiDoc files to remove "Chapter X:" prefix for a cleaner presentation. - Created redirect.html for seamless navigation to the latest tutorial version. - Added supplemental UI assets including favicon images. - Implemented update-repo-url.sh script to automatically update repository URLs in configuration files based on the current Git repository and branch. * Update README and sitemap with latest modification dates * Update chapter07.adoc minor updates * Update chapter08.adoc * Update antora-assembler.yml --------- Co-authored-by: Emily Jiang <[email protected]>
1 parent 36f6d7c commit 2b64e7b

File tree

127 files changed

+21027
-89
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+21027
-89
lines changed

.devcontainer/devcontainer.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"image": "mcr.microsoft.com/devcontainers/universal:2",
3+
"features": {
4+
"ghcr.io/devcontainers-extra/features/node-asdf:0": {}
5+
},
6+
"customizations": {
7+
"vscode": {
8+
"extensions": [
9+
"GitHub.copilot",
10+
"asciidoctor.asciidoctor-vscode",
11+
"microprofile-community.vscode-microprofile-pack",
12+
"vscjava.vscode-java-pack",
13+
"Open-Liberty.liberty-tools-vscode"
14+
]
15+
}
16+
}
17+
}

.github/workflows/antora.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Generate MicroProfile Tutorial
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Or your default branch
7+
8+
jobs:
9+
build-and-deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout Repository
13+
uses: actions/checkout@v2
14+
15+
- name: Set up Node.js
16+
uses: actions/setup-node@v2
17+
with:
18+
node-version: '14' # Use the Node.js version that matches your development environment
19+
20+
- name: Install Antora
21+
run: npm install -g @antora/cli @antora/site-generator-default
22+
23+
- name: Generate Site with Antora
24+
run: antora --fetch playbook.yml
25+
26+
- name: Deploy to GitHub Pages
27+
uses: peaceiris/actions-gh-pages@v3
28+
with:
29+
github_token: ${{ secrets.GITHUB_TOKEN }}
30+
publish_dir: ./build/site # The default output directory for Antora
31+
publish_branch: gh-pages # The target branch for GitHub Pages

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/node_modules/

0 commit comments

Comments
 (0)