Skip to content

Commit

Permalink
More Concerto removal
Browse files Browse the repository at this point in the history
  • Loading branch information
dselman committed Jan 31, 2017
1 parent 2ae8552 commit c1e427f
Show file tree
Hide file tree
Showing 11 changed files with 32 additions and 33 deletions.
3 changes: 2 additions & 1 deletion packages/composer-admin/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# Composer-Admin
The Composer administration API. The admin API allows users to deploy/undeploy/update BusinessNetworkDefinitions.
Fabric Composer administration API. The admin API allows users to deploy/undeploy/update BusinessNetworkDefinitions
to a Hyperledger Fabric instance.
2 changes: 1 addition & 1 deletion packages/composer-admin/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "composer-admin",
"version": "0.4.1",
"description": "Fabric Composer admin, code that manages business networks",
"description": "Fabric Composer Admin, code that manages business networks deployed to Hyperledger Fabric",
"main": "index.js",
"typings": "index.d.ts",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion packages/composer-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Composer-CLI
# Fabric Composer CLI

Set up the Composer command with

Expand Down
5 changes: 3 additions & 2 deletions packages/composer-client/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# Composer-Client
The Composer client API allows a participant in a business network to connect to the network and perform operations on the asset registries and submit transactions.
# Fabric Composer Client
Fabric Composer client API allows a participant in a business network to connect to a business network
deployed to Hyperledger Fabric and perform operations on the asset registries and submit transactions.
2 changes: 1 addition & 1 deletion packages/composer-client/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "composer-client",
"version": "0.4.1",
"description": "The node.js client library for Fabric Composer, the Hyperledger Fabric development framework",
"description": "The node.js client library for Fabric Composer, a development framework for Hyperledger Fabric",
"main": "index.js",
"typings": "index.d.ts",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion packages/composer-common/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Composer-Common
# Fabric Composer Common
Code that is shared across Composer-Client, Composer-Admin and Composer-Runtime

Defines the core of the Fabric Composer programming model, including the parser for the CTO language and services for assets, registries, participants and transactions.
20 changes: 10 additions & 10 deletions site/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
layout: default
title: Contributing to Concerto
title: Contributing to Fabric Composer
category: contributing
sidebar: sidebars/contributing.md
excerpt: Concerto project contribution guidelines
excerpt: Fabric Composer project contribution guidelines
---
# Contributing to Concerto
# Contributing to Fabric Composer

This document explains how you should work with the Concerto repository.
This document explains how you should work with the Fabric Composer repository.

## Creating a Mac OS X development environment

Expand Down Expand Up @@ -37,7 +37,7 @@ Then in a terminal type:
### Install Required Version of Node

Use the Node Version Manager (nvm) to install the correct version of
Node for Concerto.
Node for Fabric Composer.

In a terminal window type:

Expand All @@ -48,14 +48,14 @@ node_modules directory and rerun 'npm install'.

### Install dependencies

From a terminal window in the Concerto directory run:
From a terminal window in the Fabric Composer directory run:

./scripts/install-deps.sh

### Test the environment

You can now run the Unit Tests to test your development environment works.
From your checkout Concerto directory, switch to a terminal and type:
From your checkout Fabric Composer directory, switch to a terminal and type:

npm install
npm test
Expand All @@ -64,23 +64,23 @@ The tests should all pass!

## Our development process

All work on Concerto is performed on GitHub Enterprise. Changes should be developed in a fork of the Concerto repository, and the changes submitted for approval in the form of pull requests.
All work on Fabric Composer is performed on GitHub. Changes should be developed in a fork of the fabric-composer repository, and the changes submitted for approval in the form of pull requests.

| Workflow |
| :-----: |
|![Workflow diagram](docs/source/png/Contributing.Diagram.png)|

### `develop` branch

All changes and pull requests should be targeted at the `develop` branch. The `develop` branch has been configured as the default branch for the Concerto repository. When you create a pull request, a Travis CI build will automatically run to confirm that your changes build cleanly and pass all known tests. Your changes will **not** be merged into the `develop` branch unless this build runs cleanly.
All changes and pull requests should be targeted at the `develop` branch. The `develop` branch has been configured as the default branch for the fabric-composer repository. When you create a pull request, a Travis CI build will automatically run to confirm that your changes build cleanly and pass all known tests. Your changes will **not** be merged into the `develop` branch unless this build runs cleanly.

### `master` branch

We try to keep the `master` branch as stable as possible. Changes are regularly pushed from the `develop` branch up to the `master` branch once they have been confirmed to be *good*. Only specific members of the IBM Blockchain WW Labs team have permission to push to the `master` branch.

### Testing

All changes pushed to Concerto should include unit tests that ensure that the new functionality works as designed, or that fixed bugs stay fixed. Pull requests that add code changes which are not covered by automated unit tests will **not** be accepted.
All changes pushed to Fabric Composer should include unit tests that ensure that the new functionality works as designed, or that fixed bugs stay fixed. Pull requests that add code changes which are not covered by automated unit tests will **not** be accepted.

Unit testing is for ensuring that small units of code *Do The Right Thing*, with an extremely quick turnaround time. An example of this might be the `AssetRegistryFactory.create()` method. The code in this method *probably* needs to do two things; send the correct invoke request to the chain-code, and correctly handle all of the possible responses from that chain-code.

Expand Down
15 changes: 6 additions & 9 deletions site/JSDOC-README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
# Concerto API
Concerto is an application development framework for building blockchain applications based on Hyperledger. This is the API JSDoc for the Concerto Client, Admin and Runtime Javascript APIs.

[User Documentation](https://pages.github.ibm.com/Blockchain-WW-Labs/Concerto/) is on the gh-pages branch of the Concerto git repository

# Fabric Composer API
Fabric Composer is an application development framework for building blockchain applications based on Hyperledger. This is the API JSDoc for the Fabric Composer Client, Admin and Runtime Javascript APIs.

## Overview
The major components of Concerto are:
The major components of Fabric Composer are:

1. The Concerto language for describing the structure of resources (assets, participants
and transactions) that participate in a blockchain-mediated business network.
2. Javascript APIs to query, create, update and delete resources and submit transactions
from client applications. Concerto resources are stored on the blockchain.
from client applications. Fabric Composer resources are stored on the blockchain.
3. Javascript transaction processor functions that runs on Hyperledger when transactions are
submitted for processing. These functions may update the state of resources
stored on the blockchain via server-side Concerto APIs.
4. The Composer utility and tools to interactively test Concerto-based
stored on the blockchain via server-side Fabric Composer APIs.
4. The Composer utility and tools to interactively test Fabric Composer based
solutions.

## git repositories
Expand Down
10 changes: 5 additions & 5 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Concerto Documentation
# Fabric Composer Documentation

This repository is holds the documentation for Concerto and the tools to create the static website for Concerto. This static site is hosted on the gh-pages branch of the main Concerto repo. It also holds the scripts that create the API documentation; therefore this repo is in effect a node module that has a dependancy on the main Concerto modules.
This repository is holds the documentation for Fabric Composer and the tools to create the static website for Fabric Composer. This static site is hosted on the gh-pages branch of the main fabric-composer repo. It also holds the scripts that create the API documentation; therefore this repo is in effect a node module that has a dependency on the main Fabric Composer modules.

# High Level Process
In summary the documentation is generated using both Jekyll and the jsdoc tool. These are run using scripts on within Travis, with output being pushed to the gh-pages branch of the Concerto git repository.
In summary the documentation is generated using both Jekyll and the jsdoc tool. These are run using scripts on within Travis, with output being pushed to the gh-pages branch of the Fabric Composer git repository.

* The markdown files with the documentation are contained in a simple directory structure under `docs`
* Images are in the `images` directory, (note considering if these should be moved under docs next to where they are referenced)
Expand Down Expand Up @@ -41,7 +41,7 @@ to write... note that a Java Runtime is required for the plantuml even though it

## jsdocs

1. The API documentation using jsdoc are created initially; the source for these are in the node_modules directory. This is achieved by the fact the concerto npms are dependancies in the package.json. So the source code that contains the jsdoc comments will be pulled down and be contained within the node_modules directory,
1. The API documentation using jsdoc are created initially; the source for these are in the node_modules directory. This is achieved by the fact the Fabric Composer npms are dependancies in the package.json. So the source code that contains the jsdoc comments will be pulled down and be contained within the node_modules directory,
2.
```
"composer-admin": "latest",
Expand Down Expand Up @@ -96,7 +96,7 @@ The jekyll template and files are stored in this tree
### Personal fork and travis
When you push a change to your local fork of the Concerto-Docs repo, Travis will run. It will detect this fork and push to your local gh-pages. Two important things (1) If you fork the Concerto-Docs repo, it will have a gh-pages branch - but github doesn't see this as having html in it. Delete and recreate it.
When you push a change to your local fork of the fabric-composer repo, Travis will run. It will detect this fork and push to your local gh-pages. Two important things (1) If you fork the fabric-composer repo, it will have a gh-pages branch - but github doesn't see this as having html in it. Delete and recreate it.
If you want the git push to work, you'll need to add into Travis, your ssl key for github enterprise.
Expand Down
2 changes: 1 addition & 1 deletion site/jsdoc.conf
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"dateFormat": "ddd MMM Do YYYY",
"outputSourceFiles": true,
"outputSourcePath": true,
"systemName": "Concerto",
"systemName": "Fabric Composer",
"footer": " ",
"copyright": "2017 Copyright IBM Corp. All Rights Reserved",
"navType": "vertical",
Expand Down
2 changes: 1 addition & 1 deletion site/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "fabric-composer-site",
"version": "0.3.9",
"description": "Fabric Composer is a blockchain development framework: a library of assets/functions for creating blockchain-based applications.",
"description": "Fabric Composer is a blockchain development framework for Hyperledger Fabric: a library of assets/functions for creating blockchain-based applications.",
"scripts": {
"doc": "npm run docpub && npm run docpriv",
"docpub": "jsdoc --pedantic --recurse -c jsdoc.conf -t ./node_modules/ink-docstrap/template -a public,undefined -d ./out/public -R JSDOC-README.md",
Expand Down

0 comments on commit c1e427f

Please sign in to comment.