Skip to content

Commit ccb4b91

Browse files
suvajit-sarkarsuvajit-sarkar
committed
doc redesign
Signed-off-by: suvajit-sarkar <[email protected]>
1 parent d354e68 commit ccb4b91

11 files changed

+506
-20
lines changed

‎docs/pip-requirements.txt

+12
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,20 @@ sphinx==5.3.0
55
recommonmark
66
###### Installs the mSphinx theme ######
77
sphinx_rtd_theme
8+
###### Installs the mSphinx material theme ######
9+
sphinx_material
10+
###### Installs the mSphinx immaterial theme ######
11+
sphinx_immaterial
12+
###### Installs the mSphinx pydata theme ######
13+
pydata_sphinx_theme
814
###### Installs the markdown required for tables ######
915
sphinx_markdown_tables
1016
## Install mermaid ##
1117
sphinxcontrib-mermaid
18+
## Install sphinx drawio extension ##
19+
## sphinxcontrib-drawio ##
20+
## Install xvbf ##
21+
xvfbwrapper
22+
pyvirtualdisplay
1223
docutils<0.19
24+
pydantic==1.10.0

‎docs/source/bevelsamples.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Bevel Samples
2+
3+
## **Supplychain**
4+
5+
One pager and redirect to bevel samples

‎docs/source/concepts.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Concepts
2+
============
3+
This section introduces the key concepts along with their features used within Hyperledger Bevel. This section works as step one that will pave the way for new users to understand the key conceptual building blocks used in Hyperledger Bevel's architecture design.
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
8+
keyConcepts/ansible.md
9+
keyConcepts/kubernetes.md
10+
keyConcepts/helm.md
11+
keyConcepts/vault.md
12+
keyConcepts/gitops.md
13+
keyConcepts/features.md

‎docs/source/conf.py

+28-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@
3333
'sphinx.ext.todo',
3434
'sphinx_markdown_tables',
3535
'recommonmark',
36-
'sphinxcontrib.mermaid'
36+
'sphinxcontrib.mermaid',
37+
'sphinx_immaterial',
38+
# 'sphinxcontrib.drawio',
39+
'xvfbwrapper',
40+
'pyvirtualdisplay'
3741
]
3842

3943
# Add any paths that contain templates here, relative to this directory.
@@ -91,13 +95,34 @@
9195
# a list of builtin themes.
9296
#
9397
#html_theme = 'alabaster'
94-
html_theme = 'sphinx_rtd_theme'
98+
#html_theme = 'sphinx_rtd_theme'
99+
html_theme = 'sphinx_immaterial'
100+
# html_theme = 'pydata_sphinx_theme'
95101

96102
# Theme options are theme-specific and customize the look and feel of a theme
97103
# further. For a list of options available for each theme, see the
98104
# documentation.
99105
#
100-
# html_theme_options = {}
106+
html_theme_options = {
107+
"palette": [
108+
{
109+
"media": "(prefers-color-scheme: light)",
110+
"scheme": "default",
111+
"toggle": {
112+
"icon": "material/toggle-switch-off-outline",
113+
"name": "Switch to dark mode",
114+
}
115+
},
116+
{
117+
"media": "(prefers-color-scheme: dark)",
118+
"scheme": "slate",
119+
"toggle": {
120+
"icon": "material/toggle-switch",
121+
"name": "Switch to light mode",
122+
}
123+
},
124+
]
125+
}
101126

102127
# Add any paths that contain custom static files (such as style sheets) here,
103128
# relative to this directory. They are copied after the builtin static files,

‎docs/source/contribution.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contribution
2+
3+
## **Contributing guide**
4+
5+
[//]: # (##############################################################################################)
6+
[//]: # (Copyright Accenture. All Rights Reserved.)
7+
[//]: # (SPDX-License-Identifier: Apache-2.0)
8+
[//]: # (##############################################################################################)
9+
10+
<!-- # Contributing -->
11+
12+
Thank you for your interest to contribute to Bevel! 🎉
13+
14+
We welcome contributions to Hyperledger Bevel Project in many forms, and
15+
there's always plenty to do!
16+
17+
First things first, please review the [Hyperledger Code of Conduct](https://wiki.hyperledger.org/display/HYP/Hyperledger+Code+of+Conduct) before participating and please follow it in all your interactions with the project.
18+
19+
You can contibute to Bevel, as a user or/and as a developer.
20+
21+
##### As a user:
22+
23+
[Making Feature/Enhancement Proposals](https://github.com/hyperledger/bevel/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)
24+
[Reporting bugs](https://github.com/hyperledger/bevel/issues/new?assignees=&labels=bug&template=bug_report.md&title=)
25+
26+
##### As a developer:
27+
28+
Consider picking up a [“help-wanted”](https://github.com/hyperledger/bevel/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or ["good-first-issue"](https://github.com/hyperledger/bevel/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) task
29+
30+
If you can commit to full-time/part-time development, then please contact us on our [Rocketchat channel](https://chat.hyperledger.org/channel/bevel ) to work through logistics!
31+
32+
Please visit the
33+
[Developer Guide](developerguide.md) in the docs to learn how to make contributions to this exciting project.
34+
35+
#### Pull Request Process :
36+
37+
For source code integrity , Hyperledger Bevel GitHub pull requests are accepted from forked repositories only. There are also quality standards identified and documented here that will be enhanced over time.
38+
39+
1. Fork Bevel via Github UI
40+
2. Clone the fork to your local machine
41+
3. Complete the desired changes and where possible test locally (more detail to come here)
42+
4. Commit your changes
43+
i) Make sure you sign your commit using git commit -s for more information see [here](https://gist.github.com/tkuhrt/10211ae0a26a91a8c030d00344f7d11b)
44+
ii) Make sure your commit message follows [Conventional Commits syntax](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#specification); this aids in release notes generation.
45+
5. Push your changes to your feature branch
46+
6. Initiate a pull request from your fork to the base repository ( develop branch , unless it is a critical bug, in that case initiate to the main branch)
47+
7. Await DCO & linting quality checks ( CI to come soon ), as well as any feedback from reviewers.
48+
8. Work on the feedbacks to revise the PR if there are any comments
49+
9. If not, the PR gets approved , delete feature branch post the merge
50+
51+
---
52+
**NOTE:** If you are a regular contributor , please make sure to take the latest pull from the develop branch everytime before making any pull request , main branch in case of a critical defect / bug .
53+
54+
---
55+
56+
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
57+
58+
59+
## **Maintainers**
60+
61+
All maintainers details
62+
63+
## **Roadmap**
64+
65+
## **Release notes**
66+
67+
[//]: # (##############################################################################################)
68+
[//]: # (Copyright Accenture. All Rights Reserved.)
69+
[//]: # (SPDX-License-Identifier: Apache-2.0)
70+
[//]: # (##############################################################################################)
71+
72+
Release notes have been moved to GitHub [here](https://github.com/hyperledger/bevel/releases).
73+
74+

‎docs/source/getstarted.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Get Started
2+
3+
<!-- This is Getting Started page
4+
5+
.. drawio:: ../_static/Medical Blockchain and Insurance Architecture.drawio.xml
6+
:width: 500px
7+
:height: 300px
8+
9+
.. raw:: html
10+
11+
<a href="https://viewer.diagrams.net/?tags=%7B%7D&highlight=0000ff&edit=_blank&layers=1&nav=1&title=Medical%20Blockchain%20and%20Insurance%20Architecture.drawio.xml#R7Vxbl6M2Ev41PmfzYB%2BQEJdHt92T7GQ26ZOe7E7ykoNBttnByIPxtJ1fHwHiJsk2dgtMT9IvbUpCwFelUtWnywjONofvY3e7%2Fg%2FxcTgCmn8YwfkIAN1EJv2XSo65xEBGLljFgc8qVYLn4E%2FMhBqT7gMf7xoVE0LCJNg2hR6JIuwlDZkbx%2BSlWW1JwuZTt%2B4KC4Jnzw1F6f8CP1nnUhtplfwHHKzWxZN1jZVs3KIyE%2BzWrk9eaiL4OIKzmJAk%2F7U5zHCYglfgkt%2F37kRp%2BWIxjpI2N4BPs%2BDTL7Nff53%2F8fF3Z%2FHh6zIxxxDmzXx1wz374hEwQ9rgw27rRulrJ0eGhflln77rg0dCEo%2FglBbGq4X7L%2FrYGf3N%2FfuO1swAj5Lx0t0E4TG%2FZUMiQpv2cK18l6k9LdW2h1ye4EMydsNgFeUFu8SNk6yoeA36a5X%2FR7z9IYpAKs3ALa8KRFCGCZXM098paij9akSRu1RXL%2BsWwN%2FUDKiayYEvSz4%2BTauyHPqyLIkDN1rlkoeXdZDg5wzHtMIL%2FfpMvk42GQBzPbuMSeImAYky0djRMuEyCMNZpsSibegjbPtGVrpLYvIZc%2BU2WEDTzMpr745jqqZW6JRFJTDfY7LBSXzMqtcaMS1UNXOsyyuEtZesK1ZltaJ13hvLMrtW5u4q%2Bar2fF5t2WWpu7qwaVGsnmB6eQeiXTHvQ4WdgkZ3AjHZRz5Oe6c%2BaiiUqZMpMy8WeztzAEwJlYj1%2FgpfrSiFzBMxVwwLz%2FRSc2wWk61rTg0VzthlzrTCrvI3oxKxK9wPEN3PbAZeh1Rl3em9cGl72PNGTbvOShY2Mqgfhw%2Br2PUDimutDLvmgtq7EtwNAzVxRyLupgR2szPUNQH1DyLodLzapj994u032ddfQn6Rq%2BnDYsCqAJOmMgwoUQaS9AEFyni%2Ft34m2wf0%2BfD%2BgOMv6%2FWXORjrlqgMvQdl%2BC62l1JlmJ6NF0u5MiyqDaypUQbQtIGpAkm8kaiL13ij4aHepzeSoy6A%2FkRDlix64IAvA6CLqJdhTx70iJ5ouQRyT%2BRTZ4MUeRuoN6E2rXZQ211BDQSof6CxeJC4YZdYX%2Fb6KswaDAxrMbL5d7Tbx26URuydgd3CvygAG9loWGAbAthZItUZzFinCZMlg9kxLegq8h9ZKjQkmAt%2FVsMU%2Byv8zC5JnKzJikRu%2BFhJH6rhMgWyqvOBkC2D%2B%2F84SY6M%2B3H3CWkqAx%2BC5BO7Pf39W%2FqbhnH51fxQK5of2YXv7tblEI0jf5pSQfQyIhHOJe%2BC9NvzOyMKTvaEia7DQpA%2FxtacQlA9Kbs61q%2BecBxQjHHMhCe1vyP72MNnMGYqT9x4hZMz9Zy8Xor%2FWVuKcUhN%2BWuTzpJZRnYrxck91ipsSRAlu1rLT6mgllPaTsNELRawVVaWt3jibqfptBFvuTkK7C7OeMtvvN2eJfEeiXbURIP95kzYp73FsI%2BLRSxJ2KfLkn%2FYlTMxv9m4z3AG5rfFFLMjOx9Ahs%2BFJjI7l2aVndm5I4Dvrd0owqGYWdLWgu2uhZ0Pzr3oJufJJdxiz7GKGIA%2FJ%2B5nvA59OkoDTW1e31OSY3C5uyOiLCVwu2ISxdyd2TYViozireY9AK8CL5s31CVeRYV5yzlcAfm%2FCYVrcYm%2BAVGrwdXoShOinxmKJvJpVZrEgO7VYmocrw5EtaCOyFypWkRK4NubWbK4oP7uM0syAv1bA928I4EuH4QtcaTtkZWZWAUV81utSE7LnIS%2FTotIP5Jli4rpDoGR4JlNBEDKCSHNBhAYugOaDZ7gJ65lUfinGobGWUWNRbmB%2FDiHqBAfExYgQ6X9tidiGnFT7fcOkMXM%2B6PaxOM%2BTPTdcdXFzONvMmteDjfnZs17VYWYinx7s%2BY86vcf9E%2FQG59L%2F6047upnxtxu4Wf6zCKAyN6JwVY1veSF7m4XeDwpXQ%2B1mvj5eOnus9WC3cVTZ%2BmxiwFVPX8741ZeGXcZVrN%2FIV6j%2BQcJkZbQEHBgsyHANaRuSknOBogDU%2BcGY5hWa4tJL%2FjJynL%2BU2%2FMfV6Y92xle2d9l7I5zp5slGeebrVRQzeaNspzU4rSCv6FkdZDWgHFcKDzDmAadfufaOD2LqDdrwucY9gH0wUMii61I%2Fancx2CS4%2Fbdgjo6BOHDv62jpABkA74%2FqFPLB1ZwLYQQNDmXltVb4HcyNFLbxHji9lU8dRUL5HbmAuQzZYZYme0fNFwA1nFMXEvk35waMCKEc5s%2BhbJIt5kZUsFpMiirpCV7IaZGkqR7YcugkMDVgSxR4a8%2BK183WKr8OPcgqCu2XTLPmEI1wYIFrfwAVmcqSiKASwuDeWWM16sjyx45Xc06ncTYxjirNzPsY%2FjlCXie0W5QqOgTr2Q7P2r3Yzn44W9kLkZaEIH%2BmrcjM0vOtJFP6MDiaPpbFWGIfL9Isay5Cfb3nxFTtTwEycTpNq6ZrOR10wQupDaXLeq%2BWIaU9jgQPIYoR8WpxJc65hsm2%2BIS4E6ppsMWxIyiKv0XxMy9NOXx%2FxeKePOYS66lcjruitXXTfvys5NXbkiT%2Fpgm5236SYMbn%2BCyZPJbd0EEsb9bhg%2FwL8w1M6%2BF7%2BW5VJ9B5jn6ncTvyDRx53ctliELftNOPWStBM9pD4o8Gjc7i5w%2BER2AdsgsCBJQja1CtP8tJF5QjiHSPZJGES0VxZHzCjK7Mf8qmnZiQxQYt6dzSqad5i9AO0dUM0L2tw%2BLV23lUY0Fxlcq6VLGxaBCzXhAIRbczKocXwpv4NCXejzSH7EgfPT%2B%2F%2F%2BiNembR%2Fdd7%2BHkgWep%2FYPvTGnwK8v7NEpSIEW08faTub8qJtFXJxyMyObrRsd37gO%2BH0W91aBuFZPtr%2F5TWEMBgaxZEXZuaGPEXInx71bNi0rZMHbRuQDGZb4o6mQc%2BOgNNa5w5YMrZtIm0tXkXk%2BcBbei7vh1ZGz3KaBUptWaJ8DsbsxvwGddy%2Bt7Y5rqK3ZKdO07BxHZZp%2BzUTnUDTNE3X8mXatNW3fWdNi3PuqcapKqTQbNHMqgIxbciqFxvPGsitlRgZ5HodvSNEoBk%2FMoHQ7KokJxT%2B%2BqmFGAEm1cr2v4hoyWpqRMk2Lecs%2Fmm70P0uRv2i20%2FuY1GLaM1dScYY2aOq5yFw3h1V6lu5kGZIXb%2B3GycSNInamyx%2FpPexE6HmIlynbEHJpbZxr6CHzezh%2B%2FIpT9yecDeOcYybrVlZJT1rSFayCY064Dqmb%2BkSyUdq2JpJNDgAqWB8j159sl0PO7KTnczcUWRy%2FzR3cDRA7uZs%2FnnsW5pycNt1uw8Bjp1GXJyTn7Z84ITk9BJwzlIbSmMOoa4yJCjvxcJQFJgLPsQl8%2F%2BSJQk23o0L1OrfWTLdKHrZ%2BQooucTVVzSv0PmJHVde6eXVINXz8Cw%3D%3D" target="_blank">
12+
<img src="../images/testing.jpeg" alt="Diagram Alt Text">
13+
</a> -->
14+
15+
## **Cloud Setup**
16+
17+
### **Pre-requisites**
18+
19+
### **Updating configuration file**
20+
21+
### **Deploy the network**
22+
23+
## **Local Setup**
24+
25+
### **Pre-requisites**
26+
27+
### **Deploy the network**

‎docs/source/howto.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# How to
2+
3+
<!-- This is How To page
4+
5+
This is network.yaml sample file
6+
7+
<script src="https://gist.github.com/mushirlokhandwala/1fe1a8e4318c64d00c2c1caea2b77e3b.js"></script>
8+
9+
These are environment varaibles
10+
11+
<script src="https://gist.github.com/mushirlokhandwala/7403b696902f40e3d354c760b9b8d17b.js"></script>
12+
13+
These are orderer's config
14+
15+
<script src="https://gist.github.com/mushirlokhandwala/bb5e850cc98b0f07b844d423ba78dac3.js"></script> -->
16+
17+
## **Reset an existing network**
18+
19+
## **Debug a Bevel based deployment**
20+
21+
### **How to update the k8s operations**
22+
23+
(helm release ops, update value files, increase memory, pvc size)
24+
25+
## **Verify successful deplyoment**
26+
27+
(we need to work upon that)
28+
29+
## **Updating Certificates**
30+
31+
## **Adding a new node**
32+
33+
34+

‎docs/source/index.rst

+11-16
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,28 @@ An accelerator for delivering production-ready blockchain solutions
1111
**What is Hyperledger Bevel?**
1212

1313
Hyperledger Bevel is an automation framework for delivering consistent production ready DLT networks on cloud based infrastructures, enabling teams to deliver without the need to architect the solution from scratch.
14-
14+
1515
Hyperledger Bevel provides 3 key features:
1616

1717
* Security: Bevel provides a secure environment for DLT development. Bevel has best practices of key management and other security features available by default.
1818
* Scalability: Bevel has a scalable network implementation, a user can easily scale the environment and resources according to his/her needs.
1919
* Acceleration: Bevel will help in providing a blockchain solution that drives acceleration up to deployment providing an oppourtunity to participate in those deliveries and drive more services.
20-
20+
2121
It is an accelerator for all the developers to be able to use a DLT network right away.
2222
So with Hyperledger Bevel, users are able to create a DLT environment and know that it is something that will continue to be used as
2323
project management.
2424

2525
.. toctree::
26-
:maxdepth: 1
26+
2727
:caption: Table of Contents:
2828

2929
introduction
30-
keyconcepts
31-
gettingstarted
32-
operationalguide
33-
developerguide
34-
samples
35-
roadmap
36-
compatibilitytable
37-
architectureref
38-
commandsref
30+
getstarted
31+
howto
32+
concepts
33+
tutorials
34+
contribution
35+
bevelsamples
36+
reference
3937
faq
40-
glossary
41-
contributing
42-
maintainers
43-
releasenotes
38+

‎docs/source/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ is appended to the end of the existing chain formed by all previous transactions
1717
chain of blocks called the blockchain. This blockchain format contains records of all transactions
1818
and data, starting from the inception of that data structure.
1919

20-
Setting up a new DLT/Blockchain network or maintaining an existing DLT/Blockchain network in a production-scale environment is not straightforward. For the existing DLT/Blockchain platforms, each has its own architecture, which means the same way of setting up one DLT/Blockchain network cannot be applied to others.
20+
Setting up a new DLT/Blockchain network or maintaining an existing DLT/Blockchain network in a production-scale environment is not straightforward. For the existing DLT/Blockchain platforms, each has its own architecture, which means the same way of setting up one DLT/Blockchain network cannot be applied to others.
2121

2222
Therefore, when blockchain developers are asked to use an unfamiliar DLT/Blockchain platform, it requires significant effort for even experienced technicians to properly setup the DLT/Blockchain network. This is especially true in large-scale production projects across heterogeneous corporate environments, which require other key aspects such as security and service availability.
2323

0 commit comments

Comments
 (0)