Skip to content
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.

Sign up for GitHub

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

Jump to bottom

update links in readme #15

Merged
merged 4 commits into from
Nov 27, 2023
Merged

update links in readme #15

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ee718c
update links in readme jakartaee/jakartaee-tutorial#60
jhammen Nov 8, 2023
4f5a1c1
update links in readme jakartaee/jakartaee-tutorial#60
jhammen Nov 8, 2023
9ca167b
fix readme title, add links to other repos jakartaee/jakartaee-tutori…
jhammen Nov 20, 2023
d6fe307
Merge branch 'main' into main
jhammen Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# jakartaee-tutorial-playbook
# jakartaee-documentation

Root repo for building the Jakarta EE Tutorial site (from different repos).
This is the repo for building the Jakarta EE Documentation site (from different repos); currently this consists of the Jakarta EE Tutorial.

- Issue tracker: https://virtua.atlassian.net/jira/software/c/projects/JETUT/issues
- Wiki: https://virtua.atlassian.net/wiki/spaces/JETR/overview
- Repo for the tutorial content: [https://github.com/jakartaee/jakartaee-tutorial/](https://github.com/jakartaee/jakartaee-tutorial/)
- Repo for the documentation UI: [https://github.com/jakartaee/jakartaee-documentation-ui/](https://github.com/jakartaee/jakartaee-documentation-ui/)

## Prerequisites

Expand Down Expand Up @@ -39,10 +39,10 @@ mvn clean package
```

The output will be in `target/generated-docs`.
To view, just open [`target/generated-docs/index.html`](target/generated-docs/index.html) in a browser.
To view, just open [`target/generated-docs/jakartaee-tutorial/current/index.html`](target/generated-docs/jakartaee-tutorial/current/index.html) in a browser.

```bash
browse target/generated-docs/index.html
browse target/generated-docs/jakartaee-tutorial/current/index.html
```

If you face a build failure with the following log entry as the last one before the failure, basically saying "Command not found: asciidoctor-pdf":
Expand Down Expand Up @@ -72,12 +72,12 @@ mvn compile -Pauthor-mode
The output will still be in the same location, but it'll be generated from your local clone of the repos instead of the remote.

```bash
browse target/generated-docs/index.html
browse target/generated-docs/jakartaee-tutorial/current/index.html
```

## Deploying

This site is currently deployed via GitHub Pages via GitHub Actions.
For details, see the [workflow file](.github/workflows/build-and-deploy.yml).

The current URL is [https://virtua-tech.github.io/jakartaee-tutorial-playbook](https://virtua-tech.github.io/jakartaee-tutorial-playbook).
The current URL is [https://jakartaee.github.io/jakartaee-documentation/](https://jakartaee.github.io/jakartaee-documentation/).