Skip to content

Commit ab937f5

Browse files
FAB-425 - improve initial experience
Cherry picked from master 158480c 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: Iea7fa205b970dc00014078d5cf4694be0444757b Signed-off-by: Christopher Ferris <[email protected]>
1 parent 8a52862 commit ab937f5

File tree

7 files changed

+178
-221
lines changed

7 files changed

+178
-221
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
+72-83
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,40 +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)
75-
* [Developer guides](#developer-guides)
76-
* [Fabric developer's guide](#fabric-developer-guide)
77-
* [Chaincode developer's guide](#chaincode-developer-guide)
78-
* [API developer's guide](#api-developer-guide)
79-
* [Operations guide](#operations-guide)
82+
- [Read All About It](#read-all-about-it)
83+
- [Developer guides](#developer-guides)
84+
85+
- [Chaincode developer's guide](#chaincode-developer-guide)
86+
- [Application developer's guide](#application-developer-guide)
87+
- [Fabric developer's guide](#fabric-developer-guide)
8088

81-
# Getting started
89+
- [Operations guide](#operations-guide)
90+
91+
## Read all about it
8292

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

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

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

140111
- [Setting up the development environment](dev-setup/devenv.md): when developing
@@ -150,22 +121,40 @@ testing Chaincode.
150121
- [Chaincode FAQ](FAQ/chaincode_FAQ.md): a FAQ for all of your burning questions
151122
relating to Chaincode.
152123

153-
## 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
154132

155-
- [APIs - CLI, REST, and Node.js](API/CoreAPI.md)
156-
- [CLI](API/CoreAPI.md#cli): working with the command-line interface.
157-
- [REST](API/CoreAPI.md#rest-api): working with the REST API.
158-
- [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).
159148

160149
# Operations guide
161150

162-
- [Setting Up a Network](Setup/Network-setup.md): instructions for setting up a
163-
network of fabric peers.
164-
- [Certificate Authority (CA) Setup](Setup/ca-setup.md): setting up a CA to
165-
support identity, security (authentication/authorization), privacy and
166-
confidentiality.
167-
- [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.
168157

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

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

-99
This file was deleted.

0 commit comments

Comments
 (0)