Skip to content

Commit 158480c

Browse files
FAB-425 - improve initial experience
Improve the documentation to make it easier to find things, and to make the standalone sample development environment more prominent. Fixed broken link to SystemChaincodes/noop.md so that it is integrated into the documentation. Refactored the standalone doc to read better and to limit line length to 80. Added release notes. Changed to starter-kit Change-Id: I8d5f0eb62a6ac2e5e338c3c9e486c4f952f9e0e2 Signed-off-by: Christopher Ferris <[email protected]>
1 parent 57bbb61 commit 158480c

File tree

7 files changed

+306
-183
lines changed

7 files changed

+306
-183
lines changed

docs/Setup/Chaincode-setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Chaincode developers need a way to test and debug their chaincode without having
44

55
The following instructions apply to _developing_ chaincode in Go or Java. They do not apply to running in a production environment. However, if _developing_ chaincode in Java, please see the [Java chaincode setup](https://github.com/hyperledger/fabric/blob/master/docs/Setup/JAVAChaincode.md) instructions first, to be sure your environment is properly configured.
66

7-
**Note:** We have added support for [System chaincode](https://github.com/hyperledger/fabric/blob/master/docs/SystemChaincodes/noop.md).
7+
**Note:** We have added support for [System chaincode](https://github.com/hyperledger/fabric/blob/master/docs/SystemChaincode-noop.md).
88

99
## Choices
1010

File renamed without changes.

docs/index.md

100755100644
+67-80
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,25 @@ to host any mainstream language for smart contracts development.
1919

2020
## Releases
2121

22-
The fabric releases are documented
23-
[here](https://github.com/hyperledger/fabric/wiki/Fabric-Releases). We have just
24-
released our first release under the governance of the Hyperledger Project -
25-
v0.5-developer-preview.
22+
The fabric releases are documented [here](releases.md). We have just
23+
released our second release under the governance of the Hyperledger Project -
24+
v0.6-preview.
25+
26+
## Fabric Starter Kit
27+
28+
If you'd like to dive right in and get an operational experience on your local
29+
server or laptop to begin development, we have just the thing for you. We have
30+
created a standalone Docker-based [starter kit](Starter/fabric-starter-kit.md)
31+
that leverages the latest published Docker images that you can run on your
32+
laptop and be up and running in no time. That should get you going with a
33+
sample application and some simple chaincode. From there, you can go deeper
34+
by exploring our [developer guides](#developer-guides).
2635

2736
## Contributing to the project
2837

2938
We welcome contributions to the Hyperledger Project in many forms. There's
3039
always plenty to do! Full details of how to contribute to this project are
31-
documented in the [Fabric developer's guide](#fabric-developer-guide) below.
32-
33-
To contribute to this documentation, create an issue for any requests for
34-
clarification or to highlight any errors, or you may clone and update the
35-
[source](https://gerrit.hyperledger.org/r/#/admin/projects/fabric), and submit a
36-
Gerrit review (essentially the same process as for fabric development).
40+
documented in the [Fabric developer's guide](#fabric-developer's-guide) below.
3741

3842
## Maintainers
3943

@@ -45,42 +49,46 @@ Project's Technical Steering Committee (TSC).
4549
## Communication <a name="communication"></a>
4650

4751
We use [Hyperledger Slack](https://slack.hyperledger.org/) for communication and
48-
Google Hangouts&trade; for screen sharing between developers.
52+
Google Hangouts&trade; for screen sharing between developers. Our development
53+
planning and prioritization is done in [JIRA](https://jira.hyperledger.org),
54+
and we take longer running discussions/decisions to the
55+
[mailing list](http://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric).
56+
57+
## Still Have Questions?
58+
We try to maintain a comprehensive set of documentation (see below) for various audiences.
59+
However, we realize that often there are questions that remain unanswered. For
60+
any technical questions relating to the Hyperledger Fabric project not answered
61+
in this documentation, please use
62+
[StackOverflow](http://stackoverflow.com/questions/tagged/hyperledger). If you
63+
need help finding things, please don't hesitate to send a note to the
64+
[mailing list](http://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric),
65+
or ask on [Slack]((https://slack.hyperledger.org/)).
4966

5067
# Hyperledger Fabric Documentation
5168

52-
The Hyperledger
53-
[fabric](https://gerrit.hyperledger.org/r/#/admin/projects/fabric) is an
54-
implementation of blockchain technology, that has been collaboratively developed
55-
under the Linux Foundation's [Hyperledger Project](http://hyperledger.org). It
56-
leverages familiar and proven technologies, and offers a modular architecture
69+
The Hyperledger fabric is an implementation of blockchain technology, that has
70+
been collaboratively developed under the Linux Foundation's
71+
[Hyperledger Project](http://hyperledger.org). It leverages familiar and
72+
proven technologies, and offers a modular architecture
5773
that allows pluggable implementations of various function including membership
5874
services, consensus, and smart contracts (Chaincode) execution. It features
5975
powerful container technology to host any mainstream language for smart
6076
contracts development.
6177

62-
## Still Have Questions?
63-
We try to maintain a comprehensive set of documentation for various audiences.
64-
However, we realize that often there are questions that remain unanswered. For
65-
any technical questions relating to the Hyperledger Fabric project not answered
66-
in this documentation, please use
67-
[StackOverflow](http://stackoverflow.com/questions/tagged/hyperledger).
68-
69-
## TOC
78+
## Table of Contents
7079

7180
Below, you'll find the following sections:
7281

73-
- [Getting started](#getting-started)
74-
- [Quickstart](#quickstart-documentation)
82+
- [Read All About It](#read-all-about-it)
7583
- [Developer guides](#developer-guides)
7684

77-
- [Fabric developer's guide](#fabric-developer-guide)
7885
- [Chaincode developer's guide](#chaincode-developer-guide)
79-
- [API developer's guide](#api-developer-guide)
86+
- [Application developer's guide](#application-developer-guide)
87+
- [Fabric developer's guide](#fabric-developer-guide)
8088

8189
- [Operations guide](#operations-guide)
8290

83-
# Getting started
91+
## Read all about it
8492

8593
If you are new to the project, you can begin by reviewing the following links.
8694
If you'd prefer to dive right in, see the
@@ -96,47 +104,8 @@ where the community is developing use cases and requirements.
96104
the Fabric project's documentation.
97105
- [Fabric FAQs](https://github.com/hyperledger/fabric/tree/master/docs/FAQ)
98106

99-
# Quickstart documentation
100-
101-
- [Development environment set-up](dev-setup/devenv.md): if you are considering
102-
helping with development of the Hyperledger Fabric or Fabric-API projects
103-
themselves, this guide will help you install and configure all you'll need. The
104-
development environment is also useful (but, not necessary) for developing
105-
blockchain applications and/or Chaincode.
106-
- [Network setup](Setup/Network-setup.md): This document covers setting up a
107-
network on your local machine for development.
108-
- [Chaincode development environment](Setup/Chaincode-setup.md): Chaincode
109-
developers need a way to test and debug their Chaincode without having to set up
110-
a complete peer network. This document describes how to write, build, and test
111-
Chaincode in a local development environment.
112-
- [APIs](API/CoreAPI.md): This document covers the available APIs for
113-
interacting with a peer node.
114-
115107
# Developer guides
116108

117-
## Fabric developer guide
118-
119-
When you are ready to start contributing to the Hyperledger fabric project, we
120-
strongly recommend that you read the [protocol specification](protocol-spec.md)
121-
for the technical details so that you have a better understanding of how the
122-
code fits together.
123-
124-
- [Making code contributions](CONTRIBUTING.md): First, you'll want to familiarize
125-
yourself with the project's contribution guidelines.
126-
- [Setting up the development environment](dev-setup/devenv.md): after that, you
127-
will want to set up your development environment.
128-
- [Building the fabric core](dev-setup/build.md): next, try building the project
129-
in your local development environment to ensure that everything is set up
130-
correctly.
131-
- [Building outside of Vagrant](dev-setup/build.md#building-outside-of-vagrant):
132-
for the adventurous, you might try to build outside of the standard Vagrant
133-
development environment.
134-
- [Logging control](Setup/logging-control.md): describes how to tweak the logging
135-
levels of various components within the fabric.
136-
- [License header](dev-setup/headers.txt): every source file must include this
137-
license header modified to include a copyright statement for the principle
138-
author(s).
139-
140109
## Chaincode developer guide
141110

142111
- [Setting up the development environment](dev-setup/devenv.md): when developing
@@ -152,22 +121,40 @@ testing Chaincode.
152121
- [Chaincode FAQ](FAQ/chaincode_FAQ.md): a FAQ for all of your burning questions
153122
relating to Chaincode.
154123

155-
## API developer guide
124+
## Application developer guide
125+
126+
- [APIs - CLI, REST, and Node.js](API/CoreAPI.md)
127+
- [CLI](API/CoreAPI.md#cli): working with the command-line interface.
128+
- [REST](API/CoreAPI.md#rest-api): working with the REST API (*deprecated*).
129+
- [Node.js SDK](nodeSDK/node-sdk-guide.md): working with the Node.js SDK.
130+
131+
## Fabric developer guide
156132

157-
- [APIs - CLI, REST, and Node.js](API/CoreAPI.md)
158-
- [CLI](API/CoreAPI.md#cli): working with the command-line interface.
159-
- [REST](API/CoreAPI.md#rest-api): working with the REST API.
160-
- [Node.js SDK](nodeSDK/node-sdk-guide.md): working with the Node.js SDK.
133+
- [Making code contributions](CONTRIBUTING.md): First, you'll want to familiarize
134+
yourself with the project's contribution guidelines.
135+
- [Setting up the development environment](dev-setup/devenv.md): after that, you
136+
will want to set up your development environment.
137+
- [Building the fabric core](dev-setup/build.md): next, try building the project
138+
in your local development environment to ensure that everything is set up
139+
correctly.
140+
- [Building outside of Vagrant](dev-setup/build.md#building-outside-of-vagrant):
141+
for the *adventurous*, you might try to build outside of the standard Vagrant
142+
development environment.
143+
- [Logging control](Setup/logging-control.md): describes how to tweak the logging
144+
levels of various components within the fabric.
145+
- [License header](dev-setup/headers.txt): every source file must include this
146+
license header modified to include a copyright statement for the principle
147+
author(s).
161148

162149
# Operations guide
163150

164-
- [Setting Up a Network](Setup/Network-setup.md): instructions for setting up a
165-
network of fabric peers.
166-
- [Certificate Authority (CA) Setup](Setup/ca-setup.md): setting up a CA to
167-
support identity, security (authentication/authorization), privacy and
168-
confidentiality.
169-
- [Application ACL](tech/application-ACL.md): working with access control lists.
151+
- [Setting Up a Network](Setup/Network-setup.md): instructions for setting up a
152+
network of fabric peers.
153+
- [Certificate Authority (CA) Setup](Setup/ca-setup.md): setting up a CA to
154+
support identity, security (authentication/authorization), privacy and
155+
confidentiality.
156+
- [Application ACL](tech/application-ACL.md): working with access control lists.
170157

171-
## License <a name="license"></a>
158+
# License <a name="license"></a>
172159
The Hyperledger Project uses the [Apache License Version 2.0](LICENSE) software
173160
license.

docs/nodeSDK/node-sdk-self-contained.md

-99
This file was deleted.

0 commit comments

Comments
 (0)