Skip to content

Commit

Permalink
FAB-425 - improve initial experience
Browse files Browse the repository at this point in the history
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 <chrisfer@us.ibm.com>
  • Loading branch information
christo4ferris committed Sep 27, 2016
1 parent 57bbb61 commit 158480c
Show file tree
Hide file tree
Showing 7 changed files with 306 additions and 183 deletions.
2 changes: 1 addition & 1 deletion docs/Setup/Chaincode-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Chaincode developers need a way to test and debug their chaincode without having

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.

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

## Choices

Expand Down
File renamed without changes.
147 changes: 67 additions & 80 deletions docs/index.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,25 @@ to host any mainstream language for smart contracts development.

## Releases

The fabric releases are documented
[here](https://github.com/hyperledger/fabric/wiki/Fabric-Releases). We have just
released our first release under the governance of the Hyperledger Project -
v0.5-developer-preview.
The fabric releases are documented [here](releases.md). We have just
released our second release under the governance of the Hyperledger Project -
v0.6-preview.

## Fabric Starter Kit

If you'd like to dive right in and get an operational experience on your local
server or laptop to begin development, we have just the thing for you. We have
created a standalone Docker-based [starter kit](Starter/fabric-starter-kit.md)
that leverages the latest published Docker images that you can run on your
laptop and be up and running in no time. That should get you going with a
sample application and some simple chaincode. From there, you can go deeper
by exploring our [developer guides](#developer-guides).

## Contributing to the project

We welcome contributions to the Hyperledger Project in many forms. There's
always plenty to do! Full details of how to contribute to this project are
documented in the [Fabric developer's guide](#fabric-developer-guide) below.

To contribute to this documentation, create an issue for any requests for
clarification or to highlight any errors, or you may clone and update the
[source](https://gerrit.hyperledger.org/r/#/admin/projects/fabric), and submit a
Gerrit review (essentially the same process as for fabric development).
documented in the [Fabric developer's guide](#fabric-developer's-guide) below.

## Maintainers

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

We use [Hyperledger Slack](https://slack.hyperledger.org/) for communication and
Google Hangouts&trade; for screen sharing between developers.
Google Hangouts&trade; for screen sharing between developers. Our development
planning and prioritization is done in [JIRA](https://jira.hyperledger.org),
and we take longer running discussions/decisions to the
[mailing list](http://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric).

## Still Have Questions?
We try to maintain a comprehensive set of documentation (see below) for various audiences.
However, we realize that often there are questions that remain unanswered. For
any technical questions relating to the Hyperledger Fabric project not answered
in this documentation, please use
[StackOverflow](http://stackoverflow.com/questions/tagged/hyperledger). If you
need help finding things, please don't hesitate to send a note to the
[mailing list](http://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric),
or ask on [Slack]((https://slack.hyperledger.org/)).

# Hyperledger Fabric Documentation

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

## Still Have Questions?
We try to maintain a comprehensive set of documentation for various audiences.
However, we realize that often there are questions that remain unanswered. For
any technical questions relating to the Hyperledger Fabric project not answered
in this documentation, please use
[StackOverflow](http://stackoverflow.com/questions/tagged/hyperledger).

## TOC
## Table of Contents

Below, you'll find the following sections:

- [Getting started](#getting-started)
- [Quickstart](#quickstart-documentation)
- [Read All About It](#read-all-about-it)
- [Developer guides](#developer-guides)

- [Fabric developer's guide](#fabric-developer-guide)
- [Chaincode developer's guide](#chaincode-developer-guide)
- [API developer's guide](#api-developer-guide)
- [Application developer's guide](#application-developer-guide)
- [Fabric developer's guide](#fabric-developer-guide)

- [Operations guide](#operations-guide)

# Getting started
## Read all about it

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

# Quickstart documentation

- [Development environment set-up](dev-setup/devenv.md): if you are considering
helping with development of the Hyperledger Fabric or Fabric-API projects
themselves, this guide will help you install and configure all you'll need. The
development environment is also useful (but, not necessary) for developing
blockchain applications and/or Chaincode.
- [Network setup](Setup/Network-setup.md): This document covers setting up a
network on your local machine for development.
- [Chaincode development environment](Setup/Chaincode-setup.md): Chaincode
developers need a way to test and debug their Chaincode without having to set up
a complete peer network. This document describes how to write, build, and test
Chaincode in a local development environment.
- [APIs](API/CoreAPI.md): This document covers the available APIs for
interacting with a peer node.

# Developer guides

## Fabric developer guide

When you are ready to start contributing to the Hyperledger fabric project, we
strongly recommend that you read the [protocol specification](protocol-spec.md)
for the technical details so that you have a better understanding of how the
code fits together.

- [Making code contributions](CONTRIBUTING.md): First, you'll want to familiarize
yourself with the project's contribution guidelines.
- [Setting up the development environment](dev-setup/devenv.md): after that, you
will want to set up your development environment.
- [Building the fabric core](dev-setup/build.md): next, try building the project
in your local development environment to ensure that everything is set up
correctly.
- [Building outside of Vagrant](dev-setup/build.md#building-outside-of-vagrant):
for the adventurous, you might try to build outside of the standard Vagrant
development environment.
- [Logging control](Setup/logging-control.md): describes how to tweak the logging
levels of various components within the fabric.
- [License header](dev-setup/headers.txt): every source file must include this
license header modified to include a copyright statement for the principle
author(s).

## Chaincode developer guide

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

## API developer guide
## Application developer guide

- [APIs - CLI, REST, and Node.js](API/CoreAPI.md)
- [CLI](API/CoreAPI.md#cli): working with the command-line interface.
- [REST](API/CoreAPI.md#rest-api): working with the REST API (*deprecated*).
- [Node.js SDK](nodeSDK/node-sdk-guide.md): working with the Node.js SDK.

## Fabric developer guide

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

# Operations guide

- [Setting Up a Network](Setup/Network-setup.md): instructions for setting up a
network of fabric peers.
- [Certificate Authority (CA) Setup](Setup/ca-setup.md): setting up a CA to
support identity, security (authentication/authorization), privacy and
confidentiality.
- [Application ACL](tech/application-ACL.md): working with access control lists.
- [Setting Up a Network](Setup/Network-setup.md): instructions for setting up a
network of fabric peers.
- [Certificate Authority (CA) Setup](Setup/ca-setup.md): setting up a CA to
support identity, security (authentication/authorization), privacy and
confidentiality.
- [Application ACL](tech/application-ACL.md): working with access control lists.

## License <a name="license"></a>
# License <a name="license"></a>
The Hyperledger Project uses the [Apache License Version 2.0](LICENSE) software
license.
99 changes: 0 additions & 99 deletions docs/nodeSDK/node-sdk-self-contained.md

This file was deleted.

0 comments on commit 158480c

Please sign in to comment.