From 0ac9e5596c94e5d7a4b70f57ea53a23f12c5b5f8 Mon Sep 17 00:00:00 2001 From: Mik-TF Date: Mon, 17 Jun 2024 17:41:11 -0400 Subject: [PATCH] update docs inca --- docs_projectinca/astro.config.mjs | 3 ++- .../content/docs/guides/threefold_connect.md | 9 +-------- .../src/content/docs/references/disclaimer.md | 10 ++++++++++ .../src/content/docs/resources/farmerbot.md | 20 +------------------ 4 files changed, 14 insertions(+), 28 deletions(-) create mode 100644 docs_projectinca/src/content/docs/references/disclaimer.md diff --git a/docs_projectinca/astro.config.mjs b/docs_projectinca/astro.config.mjs index fa64531..a6820a2 100644 --- a/docs_projectinca/astro.config.mjs +++ b/docs_projectinca/astro.config.mjs @@ -18,7 +18,7 @@ export default defineConfig({ ], }, { - label: 'Guides', + label: 'Steps', items: [ // Each item here is one entry in the navigation menu. { label: 'Install ThreeFold Connect', link: '/guides/threefold_connect/' }, @@ -42,6 +42,7 @@ export default defineConfig({ items: [ // Each item here is one entry in the navigation menu. { label: 'Glossary', link: '/references/glossary/' }, + { label: 'Disclaimer', link: '/references/disclaimer/' }, ], }, ], diff --git a/docs_projectinca/src/content/docs/guides/threefold_connect.md b/docs_projectinca/src/content/docs/guides/threefold_connect.md index ca87348..f1871e2 100644 --- a/docs_projectinca/src/content/docs/guides/threefold_connect.md +++ b/docs_projectinca/src/content/docs/guides/threefold_connect.md @@ -29,11 +29,4 @@ We cover the steps to create a wallet: - In the menu, click on `Wallet` - Click on `Create Initial Wallet` -Once you've installed ThreeFold Connect and created a wallet, create a farm. More on this in the next section! - - -## Disclaimer - -> The information provided in this tutorial or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. -> -> **The INCA Token** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. \ No newline at end of file +Once you've installed ThreeFold Connect and created a wallet, create a farm. More on this in the next section! \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/references/disclaimer.md b/docs_projectinca/src/content/docs/references/disclaimer.md new file mode 100644 index 0000000..8404b1a --- /dev/null +++ b/docs_projectinca/src/content/docs/references/disclaimer.md @@ -0,0 +1,10 @@ +--- +title: Disclaimer +description: Disclaimer concerning Project INCA +--- + +## Disclaimer + +> The information provided in these tutorials or any related discussion is not intended as investment advice. The purpose is to provide educational and informational content only. Investing in cryptocurrencies or any other assets carries inherent risks, and it is crucial to conduct your own research and exercise caution before making any investment decisions. +> +> **The INCA Token** is not to be considered as a traditional investment instrument. The value of cryptocurrencies can be volatile, and there are no guarantees of profits or returns. Always be aware of the risks involved and make informed choices based on your own assessment and understanding. \ No newline at end of file diff --git a/docs_projectinca/src/content/docs/resources/farmerbot.md b/docs_projectinca/src/content/docs/resources/farmerbot.md index 7775b14..cd3c60e 100644 --- a/docs_projectinca/src/content/docs/resources/farmerbot.md +++ b/docs_projectinca/src/content/docs/resources/farmerbot.md @@ -46,8 +46,6 @@ Here are some examples to guide you: > Hint: Check the Z-OS monitor screen and make sure that all the 3Nodes are within the same lan (e.g. all 3Nodes addresses are between 192.168.15.00 and 192.168.15.255). -For more information on WOL, [read this section](farmerbot_information.md#how-to-prepare-your-farm-for-the-farmerbot-with-wol). - ## Deploy a Full VM For this guide, we run the Farmerbot on a Full VM running on the TFGrid. Note that while you do not need to run the Farmerbot on the TFGrid, the whole process is very simple as presented here. @@ -114,8 +112,6 @@ For farmers with **ed25519** keys, the flag `-k` should be used. Note that by de farmerbot run -k ed25519 -e ~/farmerbotfiles/.env -c ~/farmerbotfiles/config.yml -d ``` -For more information on the supported commands, the [Additional Information section](farmerbot_information.md#supported-commands-and-flags). You can also consult the [Farmerbot repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot). - Once you've verified that the Farmerbot runs properly, you can stop the Farmerbot and go to the next section to set a Farmerbot service. This step will ensure the Farmerbot keeps running after exiting the VM. ### Set a systemd Service @@ -222,10 +218,6 @@ power: periodic_wake_up_start: 01:00PM ``` -For more information on the configuration file, refer to the [Additional Information section](farmerbot_information.md#yaml-configuration-file-template). - -You can also consult the [Farmerbot repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot). - ### Environment Variables File Template (.env) The network can be either `main`, `tets`, `dev` or `qa`. The following example is with the main network. @@ -260,14 +252,4 @@ For example, the services of two Farmerbots could be named as follows: ``` farmerbot1.service farmerbot2.service -``` - -## Questions and Feedback - -This guide is meant to get you started quickly with the Farmerbot. That being said, there is a lot more that can be done with the Farmerbot. - -For more information on the Farmerbot, please refer to the [Additional Information section](./farmerbot_information.md). You can also consult the [official Farmerbot Go repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/farmerbot). - -If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](https://forum.threefold.io/) or on the [ThreeFold Farmers Chat](https://t.me/threefoldfarmers) on Telegram. - -> This is the new version of the Farmerbot written in Go. If you have any feedback and issues, please let us know! \ No newline at end of file +``` \ No newline at end of file