Skip to content

Commit 31ab26c

Browse files
committed
docs: clarify single-script local fabric setup
Signed-off-by: malsomesh9 <malsomesh9@gmail.com>
1 parent 46810ca commit 31ab26c

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/source/getting_started.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ The Fabric application stack has five layers:
2424
* :doc:`Application APIs <sdk_chaincode>`: to develop your blockchain application.
2525
* The Application: your blockchain application will utilize the Application SDKs to call smart contracts running on a Fabric network.
2626

27+
For a quick local setup, start with :doc:`Fabric and Fabric samples <install>`, which includes the
28+
`install-fabric.sh` script for downloading Fabric binaries, container images, and the samples repository.
29+
If you want to modify Fabric itself, continue afterwards with the
30+
:doc:`development environment <dev-setup/devenv>`.
31+
2732

2833
.. Licensed under Creative Commons Attribution 4.0 International License
2934
https://creativecommons.org/licenses/by/4.0/

docs/source/install.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ The `install-fabric.sh` script introduced in the next section automates the proc
2222
* `fabric-ca-client`,
2323
* `fabric-ca-server`
2424

25+
## Which setup path should I use?
26+
27+
For most users who want a working local Fabric environment with a single script, the recommended path is:
28+
29+
1. Install the required software from [Prerequisites](./prereqs.html).
30+
2. Run `install-fabric.sh` to download the Fabric binaries, Docker images, and optionally `fabric-samples`.
31+
3. Use the `fabric-samples` test network and tutorials to start a local network and deploy chaincode.
32+
33+
If you want to contribute to Fabric itself, use this install flow first and then continue with the
34+
[contributor development environment](./dev-setup/devenv.html), which adds the extra tools and steps
35+
needed to build Fabric and run its test suites.
36+
2537
## Download Fabric samples, Docker images, and binaries
2638

2739
A working directory is required - for example, Go Developers use the `$HOME/go/src/github.com/<your_github_userid>` directory.  This is a Golang Community recommendation for Go projects.

0 commit comments

Comments
 (0)