Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://eclipse-ee4j.github.io/jakartaee-tutorial/
Jakarta EE Tutorial
https://eclipse-ee4j.github.io/jakartaee-tutorial/
Last synced: about 2 months ago
JSON representation
Jakarta EE Tutorial
- Host: GitHub
- URL: https://eclipse-ee4j.github.io/jakartaee-tutorial/
- Owner: eclipse-ee4j
- License: epl-2.0
- Created: 2019-01-28T10:23:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T09:46:36.000Z (5 months ago)
- Last Synced: 2024-05-18T23:18:21.766Z (4 months ago)
- Language: Ruby
- Homepage: https://eclipse-ee4j.github.io/jakartaee-tutorial
- Size: 10 MB
- Stars: 94
- Watchers: 35
- Forks: 61
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-jakartaee.github.io - Jakarta EE Tutorial
README
### Note: This repository is no longer maintained and the project is now moved. To refer to the new project, follow this link: [Jakarta EE Tutorial](https://github.com/jakartaee/jakartaee-tutorial)
# Jakarta EE Tutorial
This repository contains the source files that are used to build the
_Jakarta Enterprise Edition (Jakarta EE) Tutorial_. The source files
are authored in [AsciiDoc](http://asciidoc.org/). AsciiDoc is similar
to markdown but is particularly suited for user documentation.
Note that the Jakarta EE Tutorial code examples are located in a
separate repository
[eclipse-ee4j/jakartaee-tutorial-examples](https://github.com/eclipse-ee4j/jakartaee-tutorial-examples).
## Contributing
The easiest way to contribute is by opening an issue in this project
that contains feedback and review comments.
The Jakarta EE Tutorial project is also open for contributions and your
help is greatly appreciated. If you have an idea for the tutorial and
want to add a section or update an existing section, then review the
following links:
* [Contribute](CONTRIBUTING.md)
* [Pull Request Acceptance Workflow](src/main/jbake/assets/pr_doc_workflow.md)
* [License](LICENSE.md)
## Building the Jakarta EE Tutorial
The following directions explain how to do local builds of the
tutorial. Note that any changes that are pushed to the master branch
automatically trigger a build of the site files and tutorial sources.
The results are automatically pushed to the gh-pages branch. You can
view the published site
[here](https://eclipse-ee4j.github.io/jakartaee-tutorial).
### Pre-Requisites
- Maven
- JDK8+
Note that manually deploying the site requires password-less
authentication. This is done by exporting your SSH public key into your
GitHub account.
### Build the Site Locally
The site is generated under `target/staging`. Open
`file:///PATH_TO_PROJECT_DIR/target/staging` in a browser to view the
output.
```
mvn generate-resources
```
### Deploy the Site to Github Pages
If you want to manually push a build to the gh-pages branch, use:
```
mvn deploy -Ppublish-site
```
Never commit changes to the *gh-pages* branch directly.
### Produce a Zip File for Download
To produce a zip file containing the generated HTML files, use:
```
mvn package
```
When making a release on GitHub, this zip file should be added to the release.
## Links
- [Asciidoctor Maven Plugin](https://asciidoctor.org/docs/asciidoctor-maven-plugin/)
- [AsciiDoc User Guide](http://asciidoc.org/userguide.html)
- [Asciidoctor quick reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference)