Skip to content

Commit 0243f0a

Browse files
authored
Fix for #30 (#31)
* Update README.adoc with fix for #30 Fix for #30, replacing my development repo with microprofile repo. * Update update-repo-url.sh with microprofile repo path Fix for #30 * Update fix-edit-links.sh, Fix for #30 Update fix-edit-links.sh, Fix for #30 - replacing path to local repo with microprofile repo. * Update playbook.yml Fix for #30 * Update antora.yml, Fix for #30 * Fix for #30, Update index.adoc * Update README.html, Fix for #30
1 parent 04cbcce commit 0243f0a

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

README.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ content:
163163
----
164164
ui:
165165
bundle:
166-
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
166+
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
167167
snapshot: true
168168
supplemental_files: ./supplemental-ui
169169
----
@@ -177,7 +177,7 @@ The `antora.yml` file defines the documentation component:
177177
name: microprofile-tutorial
178178
title: MicroProfile Tutorial
179179
version: 6.1
180-
edit_url: https://github.com/ttelang/microprofile-tutorial/edit/patch-15/modules/ROOT/pages/{path}
180+
edit_url: https://github.com/microprofile/microprofile-tutorial/tree/main/modules/ROOT/pages/{path}
181181
asciidoc:
182182
attributes:
183183
source-language: asciidoc@
@@ -291,7 +291,7 @@ The `fix-edit-links.sh` script is a necessary post-processing step in the build
291291

292292
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.
293293

294-
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`.
294+
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`.
295295

296296
## Automating Repository URL Configuration
297297

@@ -569,7 +569,7 @@ The MicroProfile Tutorial uses a customized UI bundle from the `microprofile-doc
569569
----
570570
ui:
571571
bundle:
572-
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
572+
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/tag/latest/ui-bundle.zip
573573
snapshot: true
574574
supplemental_files: ./supplemental-ui
575575
----
@@ -620,15 +620,15 @@ To update to a newer version of the UI bundle:
620620
----
621621
ui:
622622
bundle:
623-
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
623+
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/tag/latest/ui-bundle.zip
624624
snapshot: true
625625
----
626626
627627
#### Creating a Custom UI Bundle
628628

629629
If you need extensive customization beyond what supplemental files allow:
630630

631-
1. Fork the https://github.com/ttelang/microprofile-documentation-ui repository
631+
1. Fork the https://github.com/microprofile/microprofile-tutorial-ui repository
632632
2. Make your customizations following the project's README
633633
3. Build the UI bundle using `gulp bundle`
634634
4. Host the resulting ZIP file (e.g., on GitHub Releases)
@@ -648,7 +648,7 @@ You can control how Antora handles UI bundle caching:
648648
----
649649
ui:
650650
bundle:
651-
url: https://github.com/ttelang/microprofile-documentation-ui/releases/download/latest/ui-bundle.zip
651+
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
652652
snapshot: true # Always fetch the latest version
653653
# snapshot: false # Use cached version when available
654654
----
@@ -665,7 +665,7 @@ Modern UI bundles for Antora can include advanced features:
665665
----
666666
ui:
667667
bundle:
668-
url: https://example.com/ui-bundle.zip
668+
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
669669
supplemental_files: ./supplemental-ui
670670
search:
671671
engine: lunr # Or another search engine
@@ -678,7 +678,7 @@ search:
678678
----
679679
ui:
680680
bundle:
681-
url: https://example.com/ui-bundle.zip
681+
url: https://github.com/microprofile/microprofile-tutorial-ui/releases/download/latest/ui-bundle.zip
682682
output:
683683
dir: ./build/site
684684
formats:
@@ -709,7 +709,7 @@ ui:
709709
url: ./path/to/local/ui-bundle.zip
710710
snapshot: true
711711
----
712-
712+
Replease _./path/to/local/ui-bundle.zip_ with actual path to your local UI bundle under development.
713713
This approach is useful when developing your own UI bundle or testing modifications.
714714

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

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: microprofile-tutorial
22
title: MicroProfile Tutorial
33
version: 6.1
4-
edit_url: https://github.com/ttelang/microprofile-tutorial/edit/patch-15/modules/ROOT/pages/{path}
4+
edit_url: https://github.com/microprofile/microprofile-tutorial/tree/main/modules/ROOT/pages/{path}
55
asciidoc:
66
attributes:
77
source-language: asciidoc@

build/site/microprofile-tutorial/6.1/README.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ <h3 class="title"><a href="index.html">MicroProfile Tutorial</a></h3>
138138
<li><a href="README.html">README</a></li>
139139
</ul>
140140
</nav>
141-
<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>
141+
<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>
142142
</div>
143143
<div class="content">
144144
<aside class="toc sidebar" data-title="Contents" data-levels="2">

fix-edit-links.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ NC='\033[0m' # No Color
1313
SITE_DIR="/workspaces/microprofile-tutorial/build/site"
1414

1515
# GitHub repository information
16-
REPO_URL="https://github.com/ttelang/microprofile-tutorial"
16+
REPO_URL="https://github.com/microprofile/microprofile-tutorial"
1717
BRANCH="patch-15"
1818
PATH_PREFIX="modules/ROOT/pages/"
1919

index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ image::images/figureFM-1.png[MicroProfile e-Commerce Application]
7676
As you can see in the above figure, together these microservices form a robust and flexible e-Commerce application architecture, enabling scalable, efficient, and secure online shopping experiences.
7777

7878
=== Downloading the Code
79-
The code examples in this tutorial are available at this link:https://www.github.com/ttelang/microprofile-examples[repo] (TODO: to be changed).
79+
The code examples in this tutorial are available at this link:https://github.com/microprofile/microprofile-tutorial/tree/main/code[folder].
8080

8181
=== Prerequisites
8282
MicroProfile use the Java Platform, and are usually written in the Java programming language.

playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ site:
44
start_page: "index.adoc"
55
content:
66
sources:
7-
- url: "https://github.com/ttelang/microprofile-tutorial.git"
7+
- url: "https://github.com/microprofile/microprofile-tutorial.git"
88
branches: main
99
start_path: /
1010
ui:

update-repo-url.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ echo -e "${BLUE}Detecting Git repository information...${NC}"
1515
REPO_URL=$(git remote get-url origin 2>/dev/null)
1616
if [ -z "$REPO_URL" ]; then
1717
echo -e "${YELLOW}Warning: Could not determine remote repository URL.${NC}"
18-
echo -e "${YELLOW}Using default URL: https://github.com/ttelang/microprofile-tutorial${NC}"
19-
REPO_URL="https://github.com/ttelang/microprofile-tutorial"
18+
echo -e "${YELLOW}Using default URL: https://github.com/microprofile/microprofile-tutorial${NC}"
19+
REPO_URL="https://github.com/microprofile/microprofile-tutorial"
2020
else
2121
# Convert SSH URL to HTTPS URL if needed
2222
if [[ $REPO_URL == [email protected]:* ]]; then

0 commit comments

Comments
 (0)