Skip to content

Commit 182c050

Browse files
committed
[FAB-15507] Add doc
Version neutral landing page docs for chaincode Javadoc site Change-Id: I294f208d4b15595ec86b5b9970171e1343a4320f Signed-off-by: James Taylor <[email protected]>
1 parent 61be267 commit 182c050

File tree

7 files changed

+96
-1
lines changed

7 files changed

+96
-1
lines changed

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,8 @@ nbdist/
3737

3838
local-config.yaml
3939
gradle.properties
40-
.vscode/
40+
.vscode/
41+
42+
### Jekyll ###
43+
.sass-cache
44+
_site

docs/404.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "404 - Page Not Found"
3+
permalink: /404.html
4+
---
5+
6+
## The page you wanted does not exist
7+
8+
If you were looking for Javadoc, try one of the releases below:
9+
10+
{% include javadocs.html %}

docs/_config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
theme: minima
2+
title: "fabric-chaincode-java"
3+
releases:
4+
- master
5+
- release-1.4

docs/_includes/footer.html

Whitespace-only changes.

docs/_includes/header.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<header class="site-header">
2+
3+
<div class="wrapper">
4+
<a class="site-title" rel="author" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
5+
6+
{%- assign num_releases = site.releases | size -%}
7+
{%- if num_releases > 0 -%}
8+
<nav class="site-nav">
9+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
10+
<label for="nav-trigger">
11+
<span class="menu-icon">
12+
<svg viewBox="0 0 18 15" width="18px" height="15px">
13+
<path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
14+
</svg>
15+
</span>
16+
</label>
17+
18+
<div class="trigger">
19+
{%- for release in site.releases -%}
20+
<a class="page-link" href="https://github.com/hyperledger/fabric-chaincode-java/tree/{{ release }}">{{ release | escape }}</a>
21+
{%- endfor -%}
22+
</div>
23+
</nav>
24+
{%- endif -%}
25+
</div>
26+
</header>

docs/_includes/javadocs.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<ul>
2+
{%- for release in site.releases -%}
3+
<li><a class="page-link" href="{{ release | relative_url }}/api/">{{ release | escape }}</a></li>
4+
{%- endfor -%}
5+
</ul>

docs/index.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: home
3+
---
4+
5+
Hyperledger Fabric offers a number of SDKs to support developing smart contracts (chaincode)
6+
in various programming languages. There are two other smart contract SDKs available for Go, and Node.js, in addition to this Java SDK:
7+
8+
* [Go SDK documentation](https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim)
9+
* [Node.js SDK documentation](https://fabric-shim.github.io/)
10+
11+
## Documentation
12+
13+
Detailed explanation on the concepts and programming model for smart contracts can be found in the [Chaincode Tutorials section of the Hyperledger Fabric documentation](http://hyperledger-fabric.readthedocs.io/en/latest/chaincode.html).
14+
15+
Javadoc is available for each release:
16+
17+
{% include javadocs.html %}
18+
19+
## Download
20+
21+
Gradle:
22+
23+
```
24+
dependencies {
25+
implementation 'org.hyperledger.fabric-chaincode-java:fabric-chaincode-shim:VERSION'
26+
}
27+
```
28+
29+
Maven:
30+
31+
```
32+
<dependency>
33+
<groupId>org.hyperledger.fabric-chaincode-java</groupId>
34+
<artifactId>fabric-chaincode-shim</artifactId>
35+
<version>VERSION</version>
36+
</dependency>
37+
```
38+
39+
More options can be found on the [central maven repository](https://search.maven.org/artifact/org.hyperledger.fabric-chaincode-java/fabric-chaincode-shim/).
40+
41+
Check the [release notes](https://github.com/hyperledger/fabric-chaincode-java/releases) for the changes in each version.
42+
43+
## Samples
44+
45+
Java chaincode samples for commercial paper and fabcar can be found in the [fabric-samples repository](https://github.com/hyperledger/fabric-samples)

0 commit comments

Comments
 (0)