Skip to content

Publishing MicroProfile Tutorial with Antora #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 131 commits into
base: main
Choose a base branch
from

Conversation

ttelang
Copy link
Contributor

@ttelang ttelang commented Apr 1, 2025

Restructuring Content for Publishing the MicroProfile Tutorial Site with Antora.
We will be using this UI-Bundle https://github.com/microprofile/microprofile-tutorial-ui to generate the tutorial site.

ttelang and others added 30 commits February 23, 2024 03:55
Uploading Mindmap image for MicroProfile Architecture Philosophy
Adding content for Chapter01 - Introduction to MicroProfile
Incorporating feedbacks about MicroProfile History from @aeiras
Updating MPWG members
Need for MicroProfile
MicroProfile Platform Component Specifications
Standalone (Outside Umbrella) Specifications
Standalone (Outside Umbrella) Specifications
MicroProfile Implementations
Architecture Philosophy
Relationship with Jakarta EE specification
Incorportating suggestions from microprofile#5
Co-authored-by: Emily Jiang <[email protected]>
ttelang added 9 commits April 1, 2025 10:10
	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
	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
	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
	new file:   antora-assembler.yml
	modified:   antora.yml
	deleted:    nav.adoc
	new file:   package.json
	modified:   site.yml
- 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.
@Emily-Jiang
Copy link
Member

@ttelang I understand this PR is in draft. Please notify when this PR is ready to be reviewed

ttelang added 14 commits May 18, 2025 12:51
grammar and styling fixes to index.adoc (Front matter of this Tutorial)
Minor formatting changes
Removing `Chapter 1` from title
Minor formating changes
renaming product-catalog
Minor grammatically and formatting changes.
Minor grammatical and formatting fixes.
ttelang added 4 commits May 26, 2025 15:37
- 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.
- 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.
@ttelang ttelang marked this pull request as ready for review May 27, 2025 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants