{"id":25635047,"url":"https://github.com/apache/db-jdo-site","last_synced_at":"2025-04-14T20:23:17.408Z","repository":{"id":38818019,"uuid":"183533207","full_name":"apache/db-jdo-site","owner":"apache","description":"Apache JDO project","archived":false,"fork":false,"pushed_at":"2025-04-08T18:53:24.000Z","size":27604,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-10T11:58:46.951Z","etag":null,"topics":["apache","api","database","db","java","jdo","jpa","jta","nosql","orm"],"latest_commit_sha":null,"homepage":"https://db.apache.org/jdo","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-26T01:14:24.000Z","updated_at":"2025-04-08T18:52:54.000Z","dependencies_parsed_at":"2025-02-21T21:47:13.538Z","dependency_job_id":null,"html_url":"https://github.com/apache/db-jdo-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdb-jdo-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdb-jdo-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdb-jdo-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdb-jdo-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/db-jdo-site/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248666508,"owners_count":21142257,"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","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":["apache","api","database","db","java","jdo","jpa","jta","nosql","orm"],"created_at":"2025-02-22T23:17:59.245Z","updated_at":"2025-04-14T20:23:17.386Z","avatar_url":"https://github.com/apache.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JDO Website\n\nThis repository contains the sources for the [Apache DB JDO website](https://db.apache.org/jdo/).\n\n## Building the Site\n\nThe content and styling of the site is defined in the [AsciiDoc](https://asciidoc.org/) format.\nIt is built using [Maven](https://maven.apache.org/).\nFor details on publishing the site see section [Publishing the Site](#publishing-the-site).\n\nThe site can be built by calling `mvn clean compile`. This generates the HTML files in `target/site`.\nMost of the site will work with the exception of the javadoc file downloads.\nIf needed, call `mvn package`. This copies the javadoc files to `target/site`.\nThe site can then be viewed by opening the local file `target/site/index.html` in a browser.\n\n### Adding Javadoc\n\nThe site contains a packaged version of the JDO API javadoc. It can be updated as follows:\n\n* Create the javadoc jar (e.g. jdo-api-3.2-javadoc.jar) in the db-jdo repository by calling the following command in the api submodule: `mvn clean install -Papache-release`.\n* Create a new folder in the javadoc resources directory e.g. `src/main/resources/javadoc/api32`.\n* Copy the javadocs jar into the new folder, e.g. `cp  jdo-api-3.2-javadoc.jar  src/main/resources/javadoc/api32`.\n* Create a new subfolder, e.g. `src/main/resources/javadoc/api32/jdo-api-3.2-javadoc`.\n* Unpack the javadoc jar in the subfolder.\n* Edit javadoc.adoc under src/main/asciidoc and create a new section 'JDO 3.2 javadoc'.\n* Add two links: one referring index.html in the subfolder and one referring the javadoc jar.\n\n## Contributing to the Site\n\nContributions to the website are always appreciated.\nIf you are new to this project, please have a look at our [Get Involved](https://db.apache.org/jdo/get-involved.html) page first.\n\nThis repository contains the JDO website source.\n\n * The AsciiDoc sources can be found in `src/main/asciidoc`. \n * The website menu is defined in `src/main/template`.\n * The converter for migrating the old HTML files to AsciiDoc can be found in `src/main/java`.\n * Additional pre-compiled resources are located in `src/main/resources`.\n\nContributions to this repository follow the default [GitHub workflow](https://guides.github.com/introduction/flow/)\nusing [forks](https://guides.github.com/activities/forking/).\n\nTo contribute changes, you can follow these steps:\n\n * Adapt the AsciiDoc files in `src/main/asciidoc` or the website menu in  `src/main/template`.\n * Build the site (see [above](#building-the-site)) and verify the generated website by viewing `target/site/index.html` locally with a web browser.\n * Commit the source changes (not the build artifacts) in your branch and open a pull request.\n\n### Reporting issues\n\nIf you find any issues please provide a PR or [create a JIRA ticket](https://issues.apache.org/jira/projects/JDO/issues/?filter=allopenissues).\n \n### Publishing the Site\n\nAfter changes have been made to the sources in the `src/main/asciidoc` or `src/main/template` directory, changes will be published automatically to the live web site by simply pushing changes to the main branch of the repository. The process is as follows:\n\n1. Pushing changes to the main branch invokes the post-push script in [`db-jdo-site/.github/workflows/deploy-site.yml`](./.github/workflows/deploy-site.yml) which builds the site in `target/site` via `mvn clean package`.\n\n2. If the build is successful, the build artifacts in the main branch are pushed to the `publish` branch.\n\n3. Once the changes have been pushed to the `publish` branch, the script in `.asf.yaml.publish` is automatically invoked. This script is executed by Apache Infrastructure machines, and it publishes changes to `db.apache.org/jdo`. It may take some time for the changes to be seen on the live site.\nDetails on the use of .asf.yaml is found [here](https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features#git.asf.yamlfeatures-WebSiteDeploymentServiceforGitRepositories).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fdb-jdo-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fdb-jdo-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fdb-jdo-site/lists"}