Skip to content

Commit 6ef657a

Browse files
committed
feat: add GitHub Pages deployment instructions and Dev Containers configuration to README
1 parent 57ac5e6 commit 6ef657a

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.adoc

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,55 @@ It will generate an UI bundle tagged `latest` which is available as {url-micropr
117117
This bundle is in turn already referenced as `ui.bundle.url` property in `antora-playbook.yml` configuration file of {url-microprofile-tutorial}[MicroProfile Tutorial Playbook].
118118

119119
The live site can be found at {url-microprofile-tutorial-live}[{url-microprofile-tutorial-live}].
120+
121+
== GitHub Pages Deployment
122+
123+
This project can also be built and deployed directly to GitHub Pages, which allows you to host the UI documentation directly from this repository.
124+
125+
=== Building for GitHub Pages
126+
127+
To build the UI for GitHub Pages locally, run:
128+
129+
$ gulp github-pages
130+
131+
This will generate the complete site in the `public` directory, ready for GitHub Pages deployment.
132+
133+
=== Automatic Deployment
134+
135+
The project includes a GitHub Actions workflow that automatically builds and deploys the site to GitHub Pages whenever changes are pushed to the main branch. The workflow:
136+
137+
1. Checks out the repository
138+
2. Sets up Node.js
139+
3. Installs dependencies
140+
4. Builds the site using the `github-pages` task
141+
5. Deploys the built site to GitHub Pages
142+
143+
To enable GitHub Pages for your fork of this repository:
144+
145+
1. Go to your repository's Settings tab
146+
2. Navigate to Pages in the left sidebar
147+
3. Under "Source", select "GitHub Actions"
148+
149+
Once deployed, your site will be available at `https://[username].github.io/microprofile-tutorial-ui/` or at a custom domain if you configure one in the GitHub Pages settings.
150+
151+
This approach allows you to maintain both the UI bundle for Antora and a standalone documentation site from the same repository.
152+
153+
== Development with Dev Containers / GitHub Codespaces
154+
155+
This project includes Dev Container configuration, making it easy to develop using Visual Studio Code Dev Containers or GitHub Codespaces. The development environment comes pre-configured with:
156+
157+
* Node.js LTS
158+
* Gulp CLI for build automation
159+
* GitHub Actions extension for workflow management
160+
* AsciiDoctor extension for documentation editing
161+
162+
=== Using GitHub Codespaces
163+
164+
To start developing using GitHub Codespaces:
165+
166+
1. Go to your repository on GitHub
167+
2. Click the green "Code" button
168+
3. Select the "Codespaces" tab
169+
4. Click "Create codespace on main"
170+
171+
This will create a cloud-based development environment with all dependencies pre-installed.

0 commit comments

Comments
 (0)