{"id":30225821,"url":"https://github.com/eclipse-ee4j/jakartaee-firstcup","last_synced_at":"2025-08-14T15:38:16.669Z","repository":{"id":48994516,"uuid":"167942531","full_name":"eclipse-ee4j/jakartaee-firstcup","owner":"eclipse-ee4j","description":"First Cup of Jakarta EE Tutorial","archived":false,"fork":false,"pushed_at":"2021-07-01T16:24:32.000Z","size":265,"stargazers_count":12,"open_issues_count":3,"forks_count":16,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-05-09T16:46:10.246Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://eclipse-ee4j.github.io/jakartaee-firstcup","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eclipse-ee4j.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-28T10:22:57.000Z","updated_at":"2024-03-30T17:36:22.000Z","dependencies_parsed_at":"2022-09-07T08:01:27.005Z","dependency_job_id":null,"html_url":"https://github.com/eclipse-ee4j/jakartaee-firstcup","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/eclipse-ee4j/jakartaee-firstcup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-ee4j%2Fjakartaee-firstcup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-ee4j%2Fjakartaee-firstcup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-ee4j%2Fjakartaee-firstcup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-ee4j%2Fjakartaee-firstcup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipse-ee4j","download_url":"https://codeload.github.com/eclipse-ee4j/jakartaee-firstcup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-ee4j%2Fjakartaee-firstcup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270443462,"owners_count":24584728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-14T02:00:10.309Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-14T15:38:08.003Z","updated_at":"2025-08-14T15:38:16.664Z","avatar_url":"https://github.com/eclipse-ee4j.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# First Cup Tutorial\n\nThis repository contains the source files that are used to build the\n_Jakarta Enterprise Edition Your First Cup: An Introduction to Jakarta EE_.\nThe source files\nare authored in [AsciiDoc](http://asciidoc.org/).  AsciiDoc is similar\nto markdown but is particularly suited for user documentation.  This\nproject also uses [JBake](http://jbake.org/). JBake is a static site\ngenerator that is inspired from Jekyll and written in Java.  JBake uses\ntemplates for the structure of the page and the body of the page is\ngenerated from AsciiDoc content.\n\nNote that the First Cup Tutorial code examples are located in a\nseparate repository\n[eclipse-ee4j/jakartaee-firstcup-examples](https://github.com/eclipse-ee4j/jakartaee-firstcup-examples).\n\n## Contributing\nThe easiest way to contribute is by opening an issue in this project\nthat contains feedback and review comments.\n\nThe First Cup Tutorial project is also open for contributions and your\nhelp is greatly appreciated. If you have an idea for the tutorial and\nwant to add a section or update an existing section, then review the\nfollowing links:\n\n* [Contribute](CONTRIBUTING.md)\n* [Pull Request Acceptance Workflow](src/main/jbake/assets/pr_doc_workflow.md)\n* [License](LICENSE.md)\n\n## Building the First Cup Tutorial\n\nThe following directions explain how to do local builds of the\ntutorial. Note that any changes that are pushed to the master branch\nautomatically trigger a build of the site files and tutorial sources.\nThe results are automatically pushed to the gh-pages branch. You can\nview the published site\n[here](https://eclipse-ee4j.github.io/jakartaee-firstcup).\n\n### Pre-Requisites\n\n- Maven\n- JDK8+\n\nNote that manually deploying the site requires password-less\nauthentication. This is done by exporting your SSH public key into your\nGitHub account.\n\n### Build the Site Locally\n\nThe site is generated under `target/staging`. Open\n`file:///PATH_TO_PROJECT_DIR/target/staging` in a browser to view the\noutput.\n\n```\nmvn generate-resources\n```\n\nYou can also invoke the JBake plugin directly:\n\n```\nmvn jbake:build\n```\n\n#### Rebuild the Site on Changes\n\nThe following command builds the site and, if kept running, detects\nchanges to the sources and incrementally renders the site. This is\nconvenient when writing content.\n\n```\nmvn jbake:watch\n```\n\n#### Serve the Site locally\n\nIf a web server is required (for example, absolute paths are used), you\ncan use the following command to start a Jetty web server at\n`http://localhost:8820`. The command also watches for changes and\nrebuilds incrementally.\n\n```\nmvn jbake:serve\n```\n\n\n### Deploy the Site to Github Pages\n\nIf you want to manually push a build to the gh-pages branch, use:\n\n```\nmvn deploy -Ppublish-site\n```\nNever commit changes to the gh-pages branch directly.\n\n### Produce a Zip File for Download\n\nTo produce a zip file containing the generated HTML files, use:\n\n```\nmvn package\n```\n\nWhen making a release on GitHub, this zip file should be added to the release.\n\n## Links\n\n- [JBake maven plugin documentation](https://github.com/Blazebit/jbake-maven-plugin)\n- [JBake documentation](http://jbake.org/docs/2.5.1)\n- [Freemarker documentation](http://freemarker.org/docs)\n- [AsciiDoc User Guide](http://asciidoc.org/userguide.html)\n- [Asciidoctor quick reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-ee4j%2Fjakartaee-firstcup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipse-ee4j%2Fjakartaee-firstcup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-ee4j%2Fjakartaee-firstcup/lists"}