Skip to content

Commit

Permalink
[doc] fix doc after remove bc-shaded (apache#7454)
Browse files Browse the repository at this point in the history 
* fix bc doc after remove bc-shaded

* Update site2/docs/security-bouncy-castle.md

Co-authored-by: Yu Liu <[email protected]>

Co-authored-by: Sijie Guo <[email protected]>
Co-authored-by: Yu Liu <[email protected]>
  • Loading branch information
@jiazhai @sijie @Anonymitaet
3 people authored Jul 6, 2020
1 parent 71ee00d commit ceecc78
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 21 deletions.
8 changes: 3 additions & 5 deletions site2/docs/security-bouncy-castle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ Pulsar module `bouncy-castle-bc`, which defined by `bouncy-castle/bc/pom.xml` co
</dependency>
```

And based on Pulsar module `bouncy-castle-bc`, Pulsar shades a fat jar in module `bouncy-castle-bc-shaded` that contains needed classes of BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc-shaded` module, user can easily include and exclude BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc` module, you can easily include and exclude BouncyCastle non-FIPS jars.

### Pulsar Client and Broker dependencies on BC-non-FIPS

Expand All @@ -47,7 +46,7 @@ Pulsar Client(`pulsar-client-original`) module include BouncyCastle non-FIPS jar
```xml
<dependency>
<groupId>org.apache.pulsar</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
<version>${project.parent.version}</version>
</dependency>
```
Expand Down Expand Up @@ -95,7 +94,7 @@ For example:
<exclusions>
<exclusion>
<groupId>${project.groupId}</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
</exclusion>
</exclusions>
</dependency>
Expand All @@ -118,4 +117,3 @@ Besides this, module `bouncy-castle-bcfips` builds contain an output with format

For more example, you can reference module `bcfips-include-test` and `bcfips-nar-test`.


7 changes: 3 additions & 4 deletions site2/website/versioned_docs/version-2.5.1/security-bouncy-castle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ Pulsar module `bouncy-castle-bc`, which defined by `bouncy-castle/bc/pom.xml` co
</dependency>
```

And based on Pulsar module `bouncy-castle-bc`, Pulsar shades a fat jar in module `bouncy-castle-bc-shaded` that contains needed classes of BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc-shaded` module, user can easily include and exclude BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc` module, user can easily include and exclude BouncyCastle non-FIPS jars.

### Pulsar Client and Broker dependencies on BC-non-FIPS

Expand All @@ -48,7 +47,7 @@ Pulsar Client(`pulsar-client-original`) module include BouncyCastle non-FIPS jar
```xml
<dependency>
<groupId>org.apache.pulsar</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
<version>${project.parent.version}</version>
</dependency>
```
Expand Down Expand Up @@ -96,7 +95,7 @@ For example:
<exclusions>
<exclusion>
<groupId>${project.groupId}</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
</exclusion>
</exclusions>
</dependency>
Expand Down
7 changes: 3 additions & 4 deletions site2/website/versioned_docs/version-2.5.2/security-bouncy-castle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ Pulsar module `bouncy-castle-bc`, which defined by `bouncy-castle/bc/pom.xml` co
</dependency>
```

And based on Pulsar module `bouncy-castle-bc`, Pulsar shades a fat jar in module `bouncy-castle-bc-shaded` that contains needed classes of BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc-shaded` module, user can easily include and exclude BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc` module, user can easily include and exclude BouncyCastle non-FIPS jars.

### Pulsar Client and Broker dependencies on BC-non-FIPS

Expand All @@ -48,7 +47,7 @@ Pulsar Client(`pulsar-client-original`) module include BouncyCastle non-FIPS jar
```xml
<dependency>
<groupId>org.apache.pulsar</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
<version>${project.parent.version}</version>
</dependency>
```
Expand Down Expand Up @@ -96,7 +95,7 @@ For example:
<exclusions>
<exclusion>
<groupId>${project.groupId}</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
</exclusion>
</exclusions>
</dependency>
Expand Down
7 changes: 3 additions & 4 deletions site2/website/versioned_docs/version-2.6.0/security-bouncy-castle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ Pulsar module `bouncy-castle-bc`, which defined by `bouncy-castle/bc/pom.xml` co
</dependency>
```

And based on Pulsar module `bouncy-castle-bc`, Pulsar shades a fat jar in module `bouncy-castle-bc-shaded` that contains needed classes of BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc-shaded` module, user can easily include and exclude BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc` module, user can easily include and exclude BouncyCastle non-FIPS jars.

### Pulsar Client and Broker dependencies on BC-non-FIPS

Expand All @@ -48,7 +47,7 @@ Pulsar Client(`pulsar-client-original`) module include BouncyCastle non-FIPS jar
```xml
<dependency>
<groupId>org.apache.pulsar</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
<version>${project.parent.version}</version>
</dependency>
```
Expand Down Expand Up @@ -96,7 +95,7 @@ For example:
<exclusions>
<exclusion>
<groupId>${project.groupId}</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
</exclusion>
</exclusions>
</dependency>
Expand Down
7 changes: 3 additions & 4 deletions site2/website/versioned_docs/version-2.6.1/security-bouncy-castle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ Pulsar module `bouncy-castle-bc`, which defined by `bouncy-castle/bc/pom.xml` co
</dependency>
```

And based on Pulsar module `bouncy-castle-bc`, Pulsar shades a fat jar in module `bouncy-castle-bc-shaded` that contains needed classes of BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc-shaded` module, user can easily include and exclude BouncyCastle non-FIPS jars.
By using this `bouncy-castle-bc` module, user can easily include and exclude BouncyCastle non-FIPS jars.

### Pulsar Client and Broker dependencies on BC-non-FIPS

Expand All @@ -48,7 +47,7 @@ Pulsar Client(`pulsar-client-original`) module include BouncyCastle non-FIPS jar
```xml
<dependency>
<groupId>org.apache.pulsar</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
<version>${project.parent.version}</version>
</dependency>
```
Expand Down Expand Up @@ -96,7 +95,7 @@ For example:
<exclusions>
<exclusion>
<groupId>${project.groupId}</groupId>
<artifactId>bouncy-castle-bc-shaded</artifactId>
<artifactId>bouncy-castle-bc</artifactId>
</exclusion>
</exclusions>
</dependency>
Expand Down

0 comments on commit ceecc78

Please sign in to comment.