diff --git a/docs/root/source/conf.py b/docs/root/source/conf.py index 8dc1e0e..8423132 100644 --- a/docs/root/source/conf.py +++ b/docs/root/source/conf.py @@ -70,9 +70,9 @@ extensions = [ ] try: - remove("contributing/cross-project-policies/code-of-conduct.md") - remove("contributing/cross-project-policies/release-process.md") - remove("contributing/cross-project-policies/python-style-guide.md") + remove("references/contributing/cross-project-policies/code-of-conduct.md") + remove("references/contributing/cross-project-policies/release-process.md") + remove("references/contributing/cross-project-policies/python-style-guide.md") except: print("done") @@ -85,19 +85,19 @@ def get_old_new(url, old, new): get_old_new( "https://raw.githubusercontent.com/planetmint/planetmint/master/CODE_OF_CONDUCT.md", "CODE_OF_CONDUCT.md", - "contributing/cross-project-policies/code-of-conduct.md", + "references/contributing/cross-project-policies/code-of-conduct.md", ) get_old_new( "https://raw.githubusercontent.com/planetmint/planetmint/master/RELEASE_PROCESS.md", "RELEASE_PROCESS.md", - "contributing/cross-project-policies/release-process.md", + "references/contributing/cross-project-policies/release-process.md", ) get_old_new( "https://raw.githubusercontent.com/planetmint/planetmint/master/PYTHON_STYLE_GUIDE.md", "PYTHON_STYLE_GUIDE.md", - "contributing/cross-project-policies/python-style-guide.md", + "references/contributing/cross-project-policies/python-style-guide.md", ) suppress_warnings = ["misc.highlighting_failure"] diff --git a/docs/root/source/connecting/http-client-server-api.rst b/docs/root/source/connecting/http-client-server-api.rst index 2458910..1fd8511 100644 --- a/docs/root/source/connecting/http-client-server-api.rst +++ b/docs/root/source/connecting/http-client-server-api.rst @@ -34,6 +34,7 @@ with something like the following in the body: .. _Api root endpoint: + API Root Endpoint ================= diff --git a/docs/root/source/connecting/http-samples/api-index-response.http b/docs/root/source/connecting/http-samples/api-index-response.http index 0b0deb8..e971413 100644 --- a/docs/root/source/connecting/http-samples/api-index-response.http +++ b/docs/root/source/connecting/http-samples/api-index-response.http @@ -4,7 +4,7 @@ Content-Type: application/json { "assets": "/assets/", "blocks": "/blocks/", - "docs": "https://docs.planetmint.io/projects/server/en/v1.0.1/http-client-server-api.html", + "docs": "https://docs.planetmint.io/projects/server/en/v1.2.1/http-client-server-api.html", "metadata": "/metadata/", "outputs": "/outputs/", "streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks", diff --git a/docs/root/source/connecting/http-samples/get-block-response.http b/docs/root/source/connecting/http-samples/get-block-response.http index 168c60c..d3c6ceb 100644 --- a/docs/root/source/connecting/http-samples/get-block-response.http +++ b/docs/root/source/connecting/http-samples/get-block-response.http @@ -6,23 +6,19 @@ Content-Type: application/json "transactions": [ { "asset": { - "data": { - "msg": "Hello Planetmint!" - } + "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM" }, - "id": "6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2", + "id": "e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a", "inputs": [ { - "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUBcdRj6EnG3MPl47m3XPd1HNfe7q3WL4T6MewNNnat33UvzVnPHo_vossv57M7L064VwrYMLGp097H7IeHpDngK", + "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDVDqtaQTYon0UJ-k2YEGfKfDWAwz9BnfBPkKvSHAgfU5O-1S8eY4mNjHAQConK47tnE7ksezmOrLL0_DR1Mm0P", "fulfills": null, "owners_before": [ "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD" ] } ], - "metadata": { - "sequence": 0 - }, + "metadata": "QmZs4UHLHCUGLQr6rzbtJTjT8Sf5pw6FNuaRZ5pzguk5FV", "operation": "CREATE", "outputs": [ { diff --git a/docs/root/source/connecting/http-samples/get-block-txid-request.http b/docs/root/source/connecting/http-samples/get-block-txid-request.http index 7ecb018..276d9a1 100644 --- a/docs/root/source/connecting/http-samples/get-block-txid-request.http +++ b/docs/root/source/connecting/http-samples/get-block-txid-request.http @@ -1,3 +1,3 @@ -GET /api/v1/blocks?transaction_id=6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2 HTTP/1.1 +GET /api/v1/blocks?transaction_id=e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a HTTP/1.1 Host: example.com diff --git a/docs/root/source/connecting/http-samples/get-tx-by-asset-request.http b/docs/root/source/connecting/http-samples/get-tx-by-asset-request.http index fb15c84..5a7ee61 100644 --- a/docs/root/source/connecting/http-samples/get-tx-by-asset-request.http +++ b/docs/root/source/connecting/http-samples/get-tx-by-asset-request.http @@ -1,3 +1,3 @@ -GET /api/v1/transactions?operation=TRANSFER&asset_id=6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2 HTTP/1.1 +GET /api/v1/transactions?operation=TRANSFER&asset_id=e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a HTTP/1.1 Host: example.com diff --git a/docs/root/source/connecting/http-samples/get-tx-by-asset-response.http b/docs/root/source/connecting/http-samples/get-tx-by-asset-response.http index 6ed97dc..b4cf2b7 100644 --- a/docs/root/source/connecting/http-samples/get-tx-by-asset-response.http +++ b/docs/root/source/connecting/http-samples/get-tx-by-asset-response.http @@ -3,24 +3,22 @@ Content-Type: application/json [{ "asset": { - "id": "6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2" + "id": "e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a" }, - "id": "2bf8ae1e3bc889a26df129dd6bbe6ccab30d1ae8e9e434fae1c4446042a68931", + "id": "b3f39407b3907587de26bedec93cd6b2c6958bca90f77349f1db9780f014bc1f", "inputs": [ { - "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUA90mMa9AWnbI70CUSVgzV9kRFf3tQ20RUIczNFqmwg9xrpOk_5uNoJB4bWRIojZmUhEyxSueCHLpqPXCEuyisE", + "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCtt9Thk_enrynxclNFj8B76QvIFbvhyj_38wuy1vA-lncUb2Q7bwJvnmmufeXucyEBTZQ0xoI5dfjG3KeTsLkH", "fulfills": { "output_index": 0, - "transaction_id": "6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2" + "transaction_id": "e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a" }, "owners_before": [ "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD" ] } ], - "metadata": { - "sequence": 1 - }, + "metadata": "QmQ9Sc3VWZ3nH5FWVVi2MNMDhyjTiKrEb6mN79qqt1Uq9s", "operation": "TRANSFER", "outputs": [ { @@ -41,24 +39,22 @@ Content-Type: application/json }, { "asset": { - "id": "6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2" + "id": "e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a" }, - "id": "b9b614175eaed7cc93d9b80ebc2a91d35ae31928a7c218ae982272bb1785ef16", + "id": "95d99c245cd83af10f3c8ba6c32eda7cb668698b5aaaeec67be3faf915bb6b5d", "inputs": [ { - "fulfillment": "pGSAICw7Ul-c2lG6NFbHp3FbKRC7fivQcNGO7GS4wV3A-1QggUDi2bAVKJgEyE3LzMrAnAu1PnNs9DbDNkABaY6j3OCNEVwNVNg3V3qELOFNnH8vGUevREr4E-8Vb1Kzk4VR71MO", + "fulfillment": "pGSAICw7Ul-c2lG6NFbHp3FbKRC7fivQcNGO7GS4wV3A-1QggUA2Z5Iw7YlMO0K9H_qcfGyepj6rqODxUZSysK_QS_tiZSlSdkXzCSLRCDO07EsyeBKEUUXpWHoBUv1lqJhFtjUK", "fulfills": { "output_index": 0, - "transaction_id": "2bf8ae1e3bc889a26df129dd6bbe6ccab30d1ae8e9e434fae1c4446042a68931" + "transaction_id": "b3f39407b3907587de26bedec93cd6b2c6958bca90f77349f1db9780f014bc1f" }, "owners_before": [ "3yfQPHeWAa1MxTX9Zf9176QqcpcnWcanVZZbaHb8B3h9" ] } ], - "metadata": { - "sequence": 2 - }, + "metadata": "QmRRg9RGq3TmV6nj2SXJacPuTdwaFDGTPACJLdN368pN3t", "operation": "TRANSFER", "outputs": [ { diff --git a/docs/root/source/connecting/http-samples/get-tx-id-request.http b/docs/root/source/connecting/http-samples/get-tx-id-request.http index c6c834c..f2bef71 100644 --- a/docs/root/source/connecting/http-samples/get-tx-id-request.http +++ b/docs/root/source/connecting/http-samples/get-tx-id-request.http @@ -1,3 +1,3 @@ -GET /api/v1/transactions/6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2 HTTP/1.1 +GET /api/v1/transactions/e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a HTTP/1.1 Host: example.com diff --git a/docs/root/source/connecting/http-samples/get-tx-id-response.http b/docs/root/source/connecting/http-samples/get-tx-id-response.http index c5f3b71..f1b75ec 100644 --- a/docs/root/source/connecting/http-samples/get-tx-id-response.http +++ b/docs/root/source/connecting/http-samples/get-tx-id-response.http @@ -3,23 +3,19 @@ Content-Type: application/json { "asset": { - "data": { - "msg": "Hello Planetmint!" - } + "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM" }, - "id": "6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2", + "id": "e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a", "inputs": [ { - "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUBcdRj6EnG3MPl47m3XPd1HNfe7q3WL4T6MewNNnat33UvzVnPHo_vossv57M7L064VwrYMLGp097H7IeHpDngK", + "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDVDqtaQTYon0UJ-k2YEGfKfDWAwz9BnfBPkKvSHAgfU5O-1S8eY4mNjHAQConK47tnE7ksezmOrLL0_DR1Mm0P", "fulfills": null, "owners_before": [ "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD" ] } ], - "metadata": { - "sequence": 0 - }, + "metadata": "QmZs4UHLHCUGLQr6rzbtJTjT8Sf5pw6FNuaRZ5pzguk5FV", "operation": "CREATE", "outputs": [ { diff --git a/docs/root/source/connecting/http-samples/index-response.http b/docs/root/source/connecting/http-samples/index-response.http index e1cca43..bdcad46 100644 --- a/docs/root/source/connecting/http-samples/index-response.http +++ b/docs/root/source/connecting/http-samples/index-response.http @@ -6,7 +6,7 @@ Content-Type: application/json "v1": { "assets": "/api/v1/assets/", "blocks": "/api/v1/blocks/", - "docs": "https://docs.planetmint.io/projects/server/en/v1.0.1/http-client-server-api.html", + "docs": "https://docs.planetmint.io/projects/server/en/v1.2.1/http-client-server-api.html", "metadata": "/api/v1/metadata/", "outputs": "/api/v1/outputs/", "streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks", @@ -15,7 +15,7 @@ Content-Type: application/json "validators": "/api/v1/validators" } }, - "docs": "https://docs.planetmint.io/projects/server/en/v1.0.1/", + "docs": "https://docs.planetmint.io/projects/server/en/v1.2.1/", "software": "Planetmint", - "version": "1.0.1" + "version": "1.2.1" } diff --git a/docs/root/source/connecting/http-samples/post-tx-request.http b/docs/root/source/connecting/http-samples/post-tx-request.http index 8ab0710..86d7688 100644 --- a/docs/root/source/connecting/http-samples/post-tx-request.http +++ b/docs/root/source/connecting/http-samples/post-tx-request.http @@ -4,23 +4,19 @@ Content-Type: application/json { "asset": { - "data": { - "msg": "Hello Planetmint!" - } + "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM" }, - "id": "6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2", + "id": "e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a", "inputs": [ { - "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUBcdRj6EnG3MPl47m3XPd1HNfe7q3WL4T6MewNNnat33UvzVnPHo_vossv57M7L064VwrYMLGp097H7IeHpDngK", + "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDVDqtaQTYon0UJ-k2YEGfKfDWAwz9BnfBPkKvSHAgfU5O-1S8eY4mNjHAQConK47tnE7ksezmOrLL0_DR1Mm0P", "fulfills": null, "owners_before": [ "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD" ] } ], - "metadata": { - "sequence": 0 - }, + "metadata": "QmZs4UHLHCUGLQr6rzbtJTjT8Sf5pw6FNuaRZ5pzguk5FV", "operation": "CREATE", "outputs": [ { diff --git a/docs/root/source/connecting/http-samples/post-tx-response.http b/docs/root/source/connecting/http-samples/post-tx-response.http index 653014e..75639d2 100644 --- a/docs/root/source/connecting/http-samples/post-tx-response.http +++ b/docs/root/source/connecting/http-samples/post-tx-response.http @@ -3,23 +3,19 @@ Content-Type: application/json { "asset": { - "data": { - "msg": "Hello Planetmint!" - } + "data": "QmQP5C3PmhH9oB84n7YqSY4WVqmYatdoo1BdwhH4zmcwqM" }, - "id": "6438c733f53dff60bdeded80e8c95126dd3a7ce8c1ee5d5591d030e61cde35d2", + "id": "e4ebc02324e10925226bf2143363c1a28481ee38f70a9245a5a76df5f4380a7a", "inputs": [ { - "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUBcdRj6EnG3MPl47m3XPd1HNfe7q3WL4T6MewNNnat33UvzVnPHo_vossv57M7L064VwrYMLGp097H7IeHpDngK", + "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUDVDqtaQTYon0UJ-k2YEGfKfDWAwz9BnfBPkKvSHAgfU5O-1S8eY4mNjHAQConK47tnE7ksezmOrLL0_DR1Mm0P", "fulfills": null, "owners_before": [ "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD" ] } ], - "metadata": { - "sequence": 0 - }, + "metadata": "QmZs4UHLHCUGLQr6rzbtJTjT8Sf5pw6FNuaRZ5pzguk5FV", "operation": "CREATE", "outputs": [ { diff --git a/docs/root/source/connecting/query.rst b/docs/root/source/connecting/query.rst index 513bc18..29f3296 100644 --- a/docs/root/source/connecting/query.rst +++ b/docs/root/source/connecting/query.rst @@ -193,7 +193,7 @@ In Planetmint version 2.0.0 and later, each node has its own isolated local Mong Inter-node communications are done using Tendermint protocols, not MongoDB protocols, as illustrated in Figure 1 below. If a node's local MongoDB database gets compromised, none of the other MongoDB databases (in the other nodes) will be affected. -.. figure:: _static/schemaDB.png +.. figure:: ../_static/schemaDB.png :alt: Diagram of a four-node Planetmint 2.0 network :align: center diff --git a/docs/root/source/index.rst b/docs/root/source/index.rst index 218a43a..6b71453 100644 --- a/docs/root/source/index.rst +++ b/docs/root/source/index.rst @@ -15,22 +15,12 @@ including decentralization, immutability and native support for assets. At a high level, one can communicate with a Planetmint network (set of nodes) using the Planetmint HTTP API, or a wrapper for that API, such as the Planetmint Python Driver. Each Planetmint node runs Planetmint Server and various other software. The `terminology page `_ explains some of those terms in more detail. .. toctree:: - :maxdepth: 3 + :maxdepth: 4 Introdcution Using Planetmint Node Setup Networks & Federations Connecting to Planetmint - tools/index - contributing/index - terminology - troubleshooting + References - -.. toctree:: - :maxdepth: 1 - :caption: Cryptoconditions & Smart Contracts - - Crypto Conditions & Smart Contracts - cryptoconditions diff --git a/docs/root/source/introduction/index.rst b/docs/root/source/introduction/index.rst index e3254d9..d6c89d4 100644 --- a/docs/root/source/introduction/index.rst +++ b/docs/root/source/introduction/index.rst @@ -1,10 +1,10 @@ Introduction ############ -.. include:: quickstart.md - :parser: myst_parser.sphinx_ .. include:: about-planetmint.rst :parser: myst_parser.sphinx_ +.. include:: quickstart.md + :parser: myst_parser.sphinx_ .. include:: properties.md :parser: myst_parser.sphinx_ diff --git a/docs/root/source/introduction/quickstart.md b/docs/root/source/introduction/quickstart.md index 5549856..4857e58 100644 --- a/docs/root/source/introduction/quickstart.md +++ b/docs/root/source/introduction/quickstart.md @@ -85,4 +85,4 @@ Setting up a cluster of nodes comes down to set up a cluster of tendermint nodes To develop an app that talks to a Planetmint network, you'll want a test network to test it against. You have a few options: 1. The IPDB Test Network (or "Testnet") is a free-to-use, publicly-available test network that you can test against. It is available at [IPDB testnet](https://test.ipdb.io/). -1. You could also run a Planetmint node on you local machine. One way is to use this node setup guide with a one-node "network" by using the all-in-one docker solution, or manual installation and configuration of the components. Another way is to use one of the deployment methods listed in the [network setup guide](../network-setup/index) or in the [the docs about contributing to Planetmint](../contributing/index). +1. You could also run a Planetmint node on you local machine. One way is to use this node setup guide with a one-node "network" by using the all-in-one docker solution, or manual installation and configuration of the components. Another way is to use one of the deployment methods listed in the [network setup guide](../network-setup/index) or in the [the docs about contributing to Planetmint](../references/contributing/index). diff --git a/docs/root/source/network-setup/k8s-deployment-template/template-kubernetes-azure.rst b/docs/root/source/network-setup/k8s-deployment-template/template-kubernetes-azure.rst index 7b90648..5b1a57a 100644 --- a/docs/root/source/network-setup/k8s-deployment-template/template-kubernetes-azure.rst +++ b/docs/root/source/network-setup/k8s-deployment-template/template-kubernetes-azure.rst @@ -50,7 +50,7 @@ for your Kubernetes VMs and nothing else.) See the :doc:`page about how to generate a key pair for SSH -<../../appendices/generate-key-pair-for-ssh>`. +<../../references/appendices/generate-key-pair-for-ssh>`. Step 3: Deploy an Azure Container Service (ACS) diff --git a/docs/root/source/node-setup/aws-setup.md b/docs/root/source/node-setup/aws-setup.md index 7ec8604..c22dbd4 100644 --- a/docs/root/source/node-setup/aws-setup.md +++ b/docs/root/source/node-setup/aws-setup.md @@ -48,7 +48,7 @@ This writes two files: `~/.aws/credentials` and `~/.aws/config`. AWS tools and p Eventually, you'll have one or more instances (virtual machines) running on AWS and you'll want to SSH to them. To do that, you need a public/private key pair. The public key will be sent to AWS, and you can tell AWS to put it in any instances you provision there. You'll keep the private key on your local workstation. -See the appendix [page about how to generate a key pair for SSH](../appendices/generate-key-pair-for-ssh). +See the appendix [page about how to generate a key pair for SSH](../references/appendices/generate-key-pair-for-ssh). ## Send the Public Key to AWS diff --git a/docs/root/source/appendices/cryptography.rst b/docs/root/source/references/appendices/cryptography.rst similarity index 100% rename from docs/root/source/appendices/cryptography.rst rename to docs/root/source/references/appendices/cryptography.rst diff --git a/docs/root/source/appendices/firewall-notes.md b/docs/root/source/references/appendices/firewall-notes.md similarity index 97% rename from docs/root/source/appendices/firewall-notes.md rename to docs/root/source/references/appendices/firewall-notes.md index 2b3a397..a6edd6b 100644 --- a/docs/root/source/appendices/firewall-notes.md +++ b/docs/root/source/references/appendices/firewall-notes.md @@ -49,7 +49,7 @@ Port 443 is the default HTTPS port (TCP). Package managers might also get some p Port 9984 is the default port for the Planetmint client-server HTTP API (TCP), which is served by Gunicorn HTTP Server. It's _possible_ allow port 9984 to accept inbound traffic from anyone, but we recommend against doing that. Instead, set up a reverse proxy server (e.g. using Nginx) and only allow traffic from there. Information about how to do that can be found [in the Gunicorn documentation](http://docs.gunicorn.org/en/stable/deploy.html). (They call it a proxy.) -If Gunicorn and the reverse proxy are running on the same server, then you'll have to tell Gunicorn to listen on some port other than 9984 (so that the reverse proxy can listen on port 9984). You can do that by setting `server.bind` to 'localhost:PORT' in the [Planetmint Configuration Settings](../node-setup/configuration), where PORT is whatever port you chose (e.g. 9983). +If Gunicorn and the reverse proxy are running on the same server, then you'll have to tell Gunicorn to listen on some port other than 9984 (so that the reverse proxy can listen on port 9984). You can do that by setting `server.bind` to 'localhost:PORT' in the [Planetmint Configuration Settings](../../node-setup/configuration), where PORT is whatever port you chose (e.g. 9983). You may want to have Gunicorn and the reverse proxy running on different servers, so that both can listen on port 9984. That would also help isolate the effects of a denial-of-service attack. diff --git a/docs/root/source/appendices/generate-key-pair-for-ssh.md b/docs/root/source/references/appendices/generate-key-pair-for-ssh.md similarity index 100% rename from docs/root/source/appendices/generate-key-pair-for-ssh.md rename to docs/root/source/references/appendices/generate-key-pair-for-ssh.md diff --git a/docs/root/source/appendices/index.rst b/docs/root/source/references/appendices/index.rst similarity index 100% rename from docs/root/source/appendices/index.rst rename to docs/root/source/references/appendices/index.rst diff --git a/docs/root/source/appendices/licenses.md b/docs/root/source/references/appendices/licenses.md similarity index 100% rename from docs/root/source/appendices/licenses.md rename to docs/root/source/references/appendices/licenses.md diff --git a/docs/root/source/appendices/log-rotation.md b/docs/root/source/references/appendices/log-rotation.md similarity index 91% rename from docs/root/source/appendices/log-rotation.md rename to docs/root/source/references/appendices/log-rotation.md index e89aa27..7ded148 100644 --- a/docs/root/source/appendices/log-rotation.md +++ b/docs/root/source/references/appendices/log-rotation.md @@ -27,7 +27,7 @@ Planetmint Server writes its logs to two files: normal logs and error logs. The Log rotation is baked into Planetmint Server using Python's `logging` module. The logs for Planetmint Server are rotated when any of the above mentioned files exceeds 209715200 bytes (i.e. approximately 209 MB). -For more information, see the docs about [the Planetmint Server configuration settings related to logging](../node-setup/configuration#log). +For more information, see the docs about [the Planetmint Server configuration settings related to logging](../../node-setup/configuration#log). ## Tendermint Logging and Log Rotation @@ -37,7 +37,7 @@ Tendermint writes its logs to the files: - `tendermint.err.log` If you started Planetmint Server and Tendermint using Monit, as suggested by our guide on -[How to Set Up a Planetmint Network](../network-setup/network-setup), +[How to Set Up a Planetmint Network](../../network-setup/network-setup), then the logs will be written to `$HOME/.planetmint-monit/logs/`. Moreover, if you started Planetmint Server and Tendermint using Monit, diff --git a/docs/root/source/appendices/ntp-notes.md b/docs/root/source/references/appendices/ntp-notes.md similarity index 100% rename from docs/root/source/appendices/ntp-notes.md rename to docs/root/source/references/appendices/ntp-notes.md diff --git a/docs/root/source/contributing/cross-project-policies/code-of-conduct.md b/docs/root/source/references/contributing/cross-project-policies/code-of-conduct.md similarity index 98% rename from docs/root/source/contributing/cross-project-policies/code-of-conduct.md rename to docs/root/source/references/contributing/cross-project-policies/code-of-conduct.md index da6e9bf..729131e 100644 --- a/docs/root/source/contributing/cross-project-policies/code-of-conduct.md +++ b/docs/root/source/references/contributing/cross-project-policies/code-of-conduct.md @@ -42,7 +42,7 @@ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Instances of abusive, harassing, or otherwise unacceptable behavior directed at yourself or another community member may be -reported by contacting a project maintainer at [mail@planetmint.io](mailto:mail@planetmint.io). All +reported by contacting a project maintainer at [mail@planetmint.io](mailto:contact@planetmint.io). All complaints will be reviewed and investigated and will result in a response that is appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an diff --git a/docs/root/source/contributing/cross-project-policies/index.rst b/docs/root/source/references/contributing/cross-project-policies/index.rst similarity index 100% rename from docs/root/source/contributing/cross-project-policies/index.rst rename to docs/root/source/references/contributing/cross-project-policies/index.rst diff --git a/docs/root/source/contributing/cross-project-policies/python-style-guide.md b/docs/root/source/references/contributing/cross-project-policies/python-style-guide.md similarity index 100% rename from docs/root/source/contributing/cross-project-policies/python-style-guide.md rename to docs/root/source/references/contributing/cross-project-policies/python-style-guide.md diff --git a/docs/root/source/contributing/cross-project-policies/release-process.md b/docs/root/source/references/contributing/cross-project-policies/release-process.md similarity index 100% rename from docs/root/source/contributing/cross-project-policies/release-process.md rename to docs/root/source/references/contributing/cross-project-policies/release-process.md diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/index.rst b/docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/index.rst similarity index 100% rename from docs/root/source/contributing/dev-setup-coding-and-contribution-process/index.rst rename to docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/index.rst diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md b/docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md similarity index 100% rename from docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md rename to docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md b/docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md similarity index 100% rename from docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md rename to docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md b/docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md similarity index 100% rename from docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md rename to docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md b/docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md similarity index 100% rename from docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md rename to docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md diff --git a/docs/root/source/contributing/dev-setup-coding-and-contribution-process/write-code.rst b/docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/write-code.rst similarity index 100% rename from docs/root/source/contributing/dev-setup-coding-and-contribution-process/write-code.rst rename to docs/root/source/references/contributing/dev-setup-coding-and-contribution-process/write-code.rst diff --git a/docs/root/source/contributing/index.rst b/docs/root/source/references/contributing/index.rst similarity index 98% rename from docs/root/source/contributing/index.rst rename to docs/root/source/references/contributing/index.rst index 36820f7..6d76b34 100644 --- a/docs/root/source/contributing/index.rst +++ b/docs/root/source/references/contributing/index.rst @@ -22,7 +22,7 @@ Contents -------- .. toctree:: - :maxdepth: 2 + :maxdepth: 4 ways-to-contribute/index dev-setup-coding-and-contribution-process/index diff --git a/docs/root/source/contributing/ways-to-contribute/index.rst b/docs/root/source/references/contributing/ways-to-contribute/index.rst similarity index 100% rename from docs/root/source/contributing/ways-to-contribute/index.rst rename to docs/root/source/references/contributing/ways-to-contribute/index.rst diff --git a/docs/root/source/contributing/ways-to-contribute/report-a-bug.md b/docs/root/source/references/contributing/ways-to-contribute/report-a-bug.md similarity index 100% rename from docs/root/source/contributing/ways-to-contribute/report-a-bug.md rename to docs/root/source/references/contributing/ways-to-contribute/report-a-bug.md diff --git a/docs/root/source/contributing/ways-to-contribute/write-docs.md b/docs/root/source/references/contributing/ways-to-contribute/write-docs.md similarity index 100% rename from docs/root/source/contributing/ways-to-contribute/write-docs.md rename to docs/root/source/references/contributing/ways-to-contribute/write-docs.md diff --git a/docs/root/source/references/index.rst b/docs/root/source/references/index.rst new file mode 100644 index 0000000..adc32f2 --- /dev/null +++ b/docs/root/source/references/index.rst @@ -0,0 +1,28 @@ + +.. Copyright © 2020 Interplanetary Database Association e.V., + Planetmint and IPDB software contributors. + SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) + Code is Apache-2.0 and docs are CC-BY-4.0 + +Node setup +========== + +You can use the all-in-one docker solution, or install Tendermint, MongoDB, and Planetmint step by step. For more advanced users and for development, the second option is recommended. + + +.. include:: tools/index.rst + :parser: myst_parser.sphinx_ +.. include:: contributing/index.rst + :parser: myst_parser.sphinx_ +.. include:: terminology.md + :parser: myst_parser.sphinx_ +.. include:: troubleshooting.md + :parser: myst_parser.sphinx_ +.. include:: appendices/index.rst + :parser: myst_parser.sphinx_ + + +Crypto Conditions & Smart Contracts +=================================== +Python Driver +============= \ No newline at end of file diff --git a/docs/root/source/terminology.md b/docs/root/source/references/terminology.md similarity index 100% rename from docs/root/source/terminology.md rename to docs/root/source/references/terminology.md diff --git a/docs/root/source/tools/index.rst b/docs/root/source/references/tools/index.rst similarity index 100% rename from docs/root/source/tools/index.rst rename to docs/root/source/references/tools/index.rst diff --git a/docs/root/source/tools/planetmint-cli.md b/docs/root/source/references/tools/planetmint-cli.md similarity index 97% rename from docs/root/source/tools/planetmint-cli.md rename to docs/root/source/references/tools/planetmint-cli.md index a29e855..b8a1126 100644 --- a/docs/root/source/tools/planetmint-cli.md +++ b/docs/root/source/references/tools/planetmint-cli.md @@ -22,7 +22,7 @@ Show the version number. `planetmint -v` does the same thing. ## planetmint configure -Generate a local configuration file (which can be used to set some or all [Planetmint node configuration settings](../node-setup/configuration)). It will ask you for the values of some configuration settings. +Generate a local configuration file (which can be used to set some or all [Planetmint node configuration settings](../../node-setup/configuration)). It will ask you for the values of some configuration settings. If you press Enter for a value, it will use the default value. At this point, only one database backend is supported: `tarantool`. @@ -42,7 +42,7 @@ planetmint -y configure tarantool ## planetmint show-config -Show the values of the [Planetmint node configuration settings](../node-setup/configuration). +Show the values of the [Planetmint node configuration settings](../../node-setup/configuration). ## planetmint init @@ -79,7 +79,7 @@ section of Python's documentation. For a more fine-grained control over the logging configuration you can use the configuration file as documented under -[Configuration Settings](../node-setup/configuration). +[Configuration Settings](../../node-setup/configuration). ## planetmint election diff --git a/docs/root/source/troubleshooting.md b/docs/root/source/references/troubleshooting.md similarity index 97% rename from docs/root/source/troubleshooting.md rename to docs/root/source/references/troubleshooting.md index 4bda6ba..92f8dd9 100644 --- a/docs/root/source/troubleshooting.md +++ b/docs/root/source/references/troubleshooting.md @@ -3,7 +3,7 @@ ## General Tips - Check the Planetmint, Tendermint and Tarantool logs. - For help with that, see the page about [Logging and Log Rotation](../appendices/log-rotation). + For help with that, see the page about [Logging and Log Rotation](appendices/log-rotation). - Try Googling the error message. ## Tendermint Tips @@ -88,7 +88,7 @@ One member can make a proposal to call an election to add a validator, remove a ## Logging -See the page in the Appendices about [logging and log rotation](../appendices/log-rotation). +See the page in the Appendices about [logging and log rotation](appendices/log-rotation). ## Other Problems