Skip to content

Latest commit

 

History

History
192 lines (132 loc) · 6.51 KB

index.md

File metadata and controls

192 lines (132 loc) · 6.51 KB
Raw

深入浅出FISCO BCOS

介绍

FISCO BCOS开源社区已沉淀120+篇技术文章，这些文章涉猎理论、开发以及应用案例等方面，有助于开发者快速上手、全面掌握FISCO BCOS，依据平台关键特性，社区对这些文章进行整理编排成《深入浅出FISCO BCOS》，供各位浏览阅读。

《深入浅出FISCO BCOS》分为六大章节，由社区全体成员共创完成并不断优化，社区开发者可以在GitHub上提交PR贡献文章，分享FISCO BCOS开发经验与使用心得。

区块链的概念与原理

.. toctree::
   :maxdepth: 1

   1_conception/understandable_blockchain.md
   1_conception/distributed_system.md
   1_conception/what_to_trust.md
   1_conception/what_should_not_trust.md
   1_conception/why_blockchain_slow.md
   1_conception/point_to_point.md
   1_conception/safe_and_controllable.md
   1_conception/on_and_off_the_blockchain.md
   1_conception/the_truth_of_tampering.md
   1_conception/simplify_blockchain.md

区块链学习必读

.. toctree::
   :maxdepth: 1

   2_required/practical_skill_tree.md
   2_required/entry_to_master.md
   2_required/go_through_sourcecode.md

FISCO BCOS的原理和特性

.. toctree::
   :maxdepth: 1

   3_features/30_architecture/index.md
   3_features/31_performance/index.md
   3_features/32_consensus/index.md
   3_features/33_storage/index.md
   3_features/34_protocol/index.md
   3_features/35_contract/index.md
   3_features/36_cryptographic/index.md
   3_features/37_safety/index.md
   3_features/38_privacy/index.md
   3_features/39_wecross/index.md

FISCO BCOS的部署运维与实战工具

.. toctree::
   :maxdepth: 1

   4_tools/five_step_to_develop_application.md
   4_tools/41_webase/index.md
   4_tools/42_buildchain/index.md
   4_tools/43_console/index.md
   4_tools/44_sdk/index.md
   4_tools/45_othertools/index.md
   4_tools/46_stresstest/index.md
   4_tools/47_maintenance/index.md

如何参与社区开发协作

.. toctree::
   :maxdepth: 1

   5_corporation/how_to_submit_pr.md
   5_corporation/5002.md

FISCO BCOS应用实践

.. toctree::
   :maxdepth: 1

   6_application/industry_application_case.md
   6_application/application_online_lending_platforms.md
   6_application/application_people_copyright.md
   6_application/application_bsn_officially_designated.md
   6_application/application_manufacturing_changhong.md
   6_application/application_on-chain_collaboration_multiple_enterprises_jianxinzhuhe.md
   6_application/application_construction_industry_digitalization_jianxinzhuhe.md

社区开发实践

.. toctree::
   :maxdepth: 1

   7_practice/kunpeng_platform_compiles_and_runs_fisco-bcos-2.6.0.md
   7_community/group_deploy_case.md
   7_community/suibe_blockchain_center_toolbox.md
   7_practice/build_chain_with_wsl_on_windows.md
   7_practice/ansible_FISCO-BCOS_Webase-deploy.md

社区写作指南

文章贡献选题

基础科普类——分享你对区块链基础概念和原理进行科普和介绍；

开发实操类——分享你的开发、部署、运维等实操经验，包括但不限于踩坑经历和闭坑经验。

应用实践类——如果你对某个场景有深入研究和探索积累，欢迎分享该应用场景下的解决方案与思路。

文章贡献PR操作指引

如果你已经是社区贡献者，可直接按照如下操作完成文章PR提交；如果你初次尝试PR贡献，请点击了解提PR基本操作指引。

1、提PR的预置条件：Fork FISCO-BCOS-DOC到个人github仓库

  1. step1：进入注册GitHub账号
  2. step2: Fork FISCO-BCOS-DOC 到个人仓库

2、分支说明

PR须提到FISCO-BCOS-DOC的dev分支

3、必备工具：git 点击参考

  1. mac系统：brew install git
  2. windows系统：点击下载安装
  3. ubuntu系统：sudo apt install git
  4. centos系统：sudo yum install git

4、主要的git命令：

（以下步骤只需要执行一次即可）

  • 将官方的FISCO-BCOS-DOC添加为upstream: git remote add upstream

（以下步骤每次都要操作）

每次提交PR之前，均需要执行以下命令，同步最新的官方文档：

  1. 拉取官方文档dev分支的最新文档：git fetch upstream dev

  2. 同步官方文档dev分支最新文档到本地：git rebase upstream/dev

    (注：本步骤可能会有冲突，如果有冲突，请解决冲突，点击参考冲突解决方法)

  3. 将同步后的文档推到个人的git仓库：git push origin -f

提交个人文档的主要命令

git add, git commit, git push等，点击参考。

5、文档格式说明

  1. 须采用markdown的格式编辑文章内容，点击参考markdown语法。
  2. (本步骤不强制) 提交PR之前，建议先基于个人仓库的文档构建readthedocs，检查构建出来的文档显示是否符合预期，并在提交PR的时候，附带说明个人构建的readthedocs链接。

点击参考readthedocs构建方法， FISCO-BCOS-DOC的readthedocs配置选项参考下表：

设置字段 设置结果
默认分支 release
文档类型 Sphinx
所需的文件 repuirements.txt
Python解释器 CPython
使用系统包 是
Python配置文件 conf.py

6、Reviewer反馈和合入

提交PR后，Reviewer会将修改意见直接在GitHub上进行反馈，你也可以添加小助手微信FISCOBCOS010进行直接沟通；最后当Reviewer合入PR时，你的文章就被录入啦！

文章PR贡献写作规范

  • 开头署名为撰稿人姓名，也可以展现个人所属公司或学校，例如，作者：张三 | FISCO BCOS核心开发者；
  • 文章内容尽量包含引言介绍，段与段之间自然衔接和过度，文末总结；
  • 文章应保证文句通顺、无语病，表述不会引起读者误解；
  • 实操类文章需确保技术点准确无误，并能完成测试跑通；
  • 如果文章中涉及到相关技术文档或代码仓库链接，为避免链接失效，请使用FISCO BCOS官方链接。