Skip to content

Commit afef564

Browse files
VerdentVerdent
committed
docs updates
1 parent 1f2fcb2 commit afef564

File tree

4 files changed

+54
-70
lines changed

4 files changed

+54
-70
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ include the TCK module and apply the appropriate Arquillian container. See the [
5959

6060
## Links
6161

62-
- [Official web site](https://eclipse-ee4j.github.io/jsonb-api)
62+
- [Official web site](https://jakartaee.github.io/jsonb-api)
6363
- [Eclipse project](https://projects.eclipse.org/projects/ee4j.jsonb)
64-
- [User's Guide](https://eclipse-ee4j.github.io/jsonb-api/docs/user-guide.html)
64+
- [User's Guide](https://jakartaee.github.io/jsonb-api/docs/user-guide.html)
6565
- [Jenkins Builds](https://ci.eclipse.org/jsonb/view/all/)
6666
- [Mailing list](https://www.eclipse.org/lists/jsonb-dev/)
6767
- [Yasson (Compatible Implementation)](https://github.com/eclipse-ee4j/yasson)

‎api/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
<name>JSON-B API</name>
3535
<description>Jakarta JSON Binding is a standard binding layer for converting Java objects to/from JSON documents.</description>
3636
<inceptionYear>2016</inceptionYear>
37-
<url>https://eclipse-ee4j.github.io/jsonb-api</url>
37+
<url>https://jakartaee.github.io/jsonb-api</url>
3838

3939
<issueManagement>
4040
<system>github</system>

‎docs/pom.xml

Lines changed: 35 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!--
33
4-
Copyright (c) 2011, 2022 Oracle and/or its affiliates. All rights reserved.
4+
Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
55
66
This program and the accompanying materials are made available under the
77
terms of the Eclipse Distribution License v. 1.0, which is available at
@@ -20,72 +20,33 @@
2020
<name>JSON Binding Docs</name>
2121

2222
<properties>
23-
<asciidoctor.maven.plugin.version>1.6.0</asciidoctor.maven.plugin.version>
24-
<asciidoctorj.version>1.6.2</asciidoctorj.version>
25-
<jruby.version>9.2.9.0</jruby.version>
26-
<rubygems.prawn.version>2.2.2</rubygems.prawn.version>
23+
<asciidoctor.maven.plugin.version>3.0.0</asciidoctor.maven.plugin.version>
24+
<asciidoctorj.version>2.5.11</asciidoctorj.version>
25+
<asciidoctorj.pdf.version>2.3.13</asciidoctorj.pdf.version>
2726
</properties>
2827

29-
<repositories>
30-
<repository>
31-
<id>mavengems</id>
32-
<url>mavengem:https://rubygems.org</url>
33-
</repository>
34-
</repositories>
35-
36-
<dependencies>
37-
<dependency>
38-
<groupId>rubygems</groupId>
39-
<artifactId>prawn</artifactId>
40-
<version>${rubygems.prawn.version}</version>
41-
<type>gem</type>
42-
<scope>provided</scope>
43-
</dependency>
44-
</dependencies>
45-
4628
<build>
4729
<defaultGoal>process-resources</defaultGoal>
4830
<plugins>
49-
<plugin>
50-
<groupId>de.saumya.mojo</groupId>
51-
<artifactId>gem-maven-plugin</artifactId>
52-
<version>1.0.10</version>
53-
<configuration>
54-
<jrubyVersion>${jruby.version}</jrubyVersion>
55-
<gemHome>${project.build.directory}/gems</gemHome>
56-
<gemPath>${project.build.directory}/gems</gemPath>
57-
</configuration>
58-
<executions>
59-
<execution>
60-
<goals>
61-
<goal>initialize</goal>
62-
</goals>
63-
</execution>
64-
</executions>
65-
</plugin>
6631
<plugin>
6732
<groupId>org.asciidoctor</groupId>
6833
<artifactId>asciidoctor-maven-plugin</artifactId>
6934
<version>${asciidoctor.maven.plugin.version}</version>
7035
<dependencies>
71-
<dependency>
72-
<groupId>org.jruby</groupId>
73-
<artifactId>jruby-complete</artifactId>
74-
<version>${jruby.version}</version>
75-
</dependency>
7636
<dependency>
7737
<groupId>org.asciidoctor</groupId>
7838
<artifactId>asciidoctorj</artifactId>
7939
<version>${asciidoctorj.version}</version>
8040
</dependency>
41+
<dependency>
42+
<groupId>org.asciidoctor</groupId>
43+
<artifactId>asciidoctorj-pdf</artifactId>
44+
<version>${asciidoctorj.pdf.version}</version>
45+
</dependency>
8146
</dependencies>
8247
<configuration>
8348
<sourceDirectory>src/docs</sourceDirectory>
8449
<sourceDocumentName>user-guide.adoc</sourceDocumentName>
85-
<gemPath>${project.build.directory}/gems-provided</gemPath>
86-
<attributes>
87-
<sourcedir>${project.build.sourceDirectory}</sourcedir>
88-
</attributes>
8950
</configuration>
9051
<executions>
9152
<execution>
@@ -96,8 +57,8 @@
9657
</goals>
9758
<configuration>
9859
<backend>html5</backend>
99-
<sourceHighlighter>coderay</sourceHighlighter>
10060
<attributes>
61+
<sourcedir>${project.build.sourceDirectory}</sourcedir>
10162
<imagesdir>./images</imagesdir>
10263
<toc>left</toc>
10364
<toclevels>3</toclevels>
@@ -109,18 +70,33 @@
10970
</attributes>
11071
</configuration>
11172
</execution>
73+
<execution>
74+
<id>generate-pdf-doc</id>
75+
<phase>generate-resources</phase>
76+
<goals>
77+
<goal>process-asciidoc</goal>
78+
</goals>
79+
<configuration>
80+
<backend>pdf</backend>
81+
<attributes>
82+
<imagesdir>./images</imagesdir>
83+
<doctype>book</doctype>
84+
<compat-mode/>
85+
<data-uri/>
86+
<icons>font</icons>
87+
<pagenums/>
88+
<toc/>
89+
<icons>font</icons>
90+
<sectanchors>true</sectanchors>
91+
<idprefix/>
92+
<idseparator>-</idseparator>
93+
<docinfo1>true</docinfo1>
94+
<embedAssets>true</embedAssets>
95+
</attributes>
96+
</configuration>
97+
</execution>
11298
</executions>
11399
</plugin>
114100
</plugins>
115-
116-
<!-- This extension converts reubygems repository to maven repository on the fly -->
117-
<!-- This is needed because of the old maven proxy address does not support HTTPS -->
118-
<extensions>
119-
<extension>
120-
<groupId>org.torquebox.mojo</groupId>
121-
<artifactId>mavengem-wagon</artifactId>
122-
<version>1.0.3</version>
123-
</extension>
124-
</extensions>
125101
</build>
126102
</project>

‎docs/src/docs/user-guide.adoc

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
:component-name: Json Binding 1.0.1 Users Guide
1+
:component-name: Json Binding 3.0.1 Users Guide
22
:toc: left
33
:toclevels: 3
4+
:source-highlighter: coderay
45

56
= {component-name}
67

@@ -14,26 +15,33 @@ JSON-B is a standard binding layer for converting Java objects to/from JSON mess
1415
.Maven Dependencies
1516
----
1617
<dependencies>
17-
<!-- JSON-P -->
18+
<!-- JSON-P API -->
1819
<dependency>
19-
<groupId>org.glassfish</groupId>
20-
<artifactId>jakarta.json</artifactId>
21-
<version>1.1.5</version>
20+
<groupId>jakarta.json</groupId>
21+
<artifactId>jakarta.json-api</artifactId>
22+
<version>2.1.3</version>
23+
</dependency>
24+
25+
<!-- Eclipse Parsson (JSON-P implementation) -->
26+
<dependency>
27+
<groupId>org.eclipse.parsson</groupId>
28+
<artifactId>parsson</artifactId>
29+
<version>1.1.6</version>
2230
<scope>runtime</scope>
2331
</dependency>
2432
2533
<!-- JSON-B API -->
2634
<dependency>
2735
<groupId>jakarta.json.bind</groupId>
2836
<artifactId>jakarta.json.bind-api</artifactId>
29-
<version>1.0.1</version>
37+
<version>3.0.1</version>
3038
</dependency>
3139
3240
<!-- Yasson (JSON-B implementation) -->
3341
<dependency>
3442
<groupId>org.eclipse</groupId>
3543
<artifactId>yasson</artifactId>
36-
<version>1.0.3</version>
44+
<version>3.0.4</version>
3745
<scope>runtime</scope>
3846
</dependency>
3947
</dependencies>
@@ -706,7 +714,7 @@ Jsonb jsonb = JsonbBuilder.create(config);
706714

707715
== Further Information
708716

709-
- JSON-B official web site: https://eclipse-ee4j.github.io/jsonb-api
717+
- JSON-B official web site: https://jakartaee.github.io/jsonb-api
710718
- Jakarta JSON Binding: https://projects.eclipse.org/projects/ee4j.jsonb
711719
- Mailing list: [email protected]
712720
- Yasson (Compatible Implementation): https://github.com/eclipse-ee4j/yasson

0 commit comments

Comments
 (0)