Skip to content

Commit

Permalink
Added authoring content information page
Browse files Browse the repository at this point in the history
  • Loading branch information
heeckhau committed Oct 31, 2022
1 parent fb5a93e commit 5712500
Show file tree
Hide file tree
Showing 7 changed files with 82 additions and 51 deletions.
44 changes: 1 addition & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,4 @@

The source code for <https://docs.ava.do>

The Avado docs website is build with [Hugo](https://gohugo.io/). You can find installation instructions at <https://gohugo.io/getting-started/installing/>

## Local builds
To test the website locally, run:
```
hugo server
```
By default, this will open a preview build at <http://localhost:1313>

## Theme

The theme is based on [GeekDocs](https://github.com/thegeeklab/hugo-geekdoc).

You can find a demo and the full documentation at <https://geekdocs.de>.


## Authoring tips

* Hint boxes (tip, important):
* Examples: <https://geekdocs.de/shortcodes/hints/>
* Code: <https://github.com/thegeeklab/hugo-geekdoc/blob/main/exampleSite/content/en/shortcodes/hints.md>
* Images:
* Short code: `{{< figure src="surge_strip.jpeg"}}`
* Parameters: <https://gohugo.io/content-management/shortcodes/#figure>
* Table of Contents:
* Short code: `{{< toc >}}`
* YouTube
* Short code: `{{< youtube w7Ft2ymGmfc >}}`
* Doc: <https://gohugo.io/content-management/shortcodes/#example-youtube-input>
* icon-sets: https://geekdocs.de/features/icon-sets/


### Link checking

Install [Broken-link-checker](https://github.com/stevenvachon/broken-link-checker):
```
npm install broken-link-checker -g
```

Run the checker: (local links only)
```
blc http://localhost:1313 --exclude-external --recursive --ordered
```
See <content/specials/authoring_content.md> for more info
4 changes: 0 additions & 4 deletions content/FAQ/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,6 @@ If this worries you, you can:
## Can I upgrade my AVADO storage
It is not currently possible to upgrade the drive storage. You can try the clean up option.

If you are running a GETH node you can run light-client to solve your problems temporary. You can check how to set up light client from this page: https://wiki.ava.do/en/tutorials/geth

Best option would be upgrading your device to i7 8TB.

## Packages/Dapps

### How can I update my packages/Dapps to the newest version?
Expand Down
2 changes: 1 addition & 1 deletion content/packages/gnosis.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ It is not difficult to follow the steps in this guide to start staking on the Gn
{{< /hint >}}

{{< hint type=tip title=success >}}
Avado makes it easy. At no point in following this Avado wiki guide will you ever need to access a command line to run a script. Official Gnosis docs are here and you can and should read them but be warned, the methods are complicated! Read the Gnosis docs but return to this guide for the "easy" method. https://docs.gnosischain.com/
Avado makes it easy. At no point in following this Avado guide will you ever need to access a command line to run a script. Official Gnosis docs are here and you can and should read them but be warned, the methods are complicated! Read the Gnosis docs but return to this guide for the "easy" method. https://docs.gnosischain.com/

{{< /hint >}}

Expand Down
5 changes: 3 additions & 2 deletions content/packages/rocketpool.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ To complete the onboarding wizard you will need these things:
1. An Ethereum wallet with 16 ETH + some gas to deposit it in your minipool (0.4 ETH should be enough)
1. An Ethereum wallet with the neccesary amount of RPL to stake.
1. An Ethereum wallet to receive your staking rewards into. This can be an empty wallet, or a cold storage wallet - as you prefer.
Check the Avado Rocket Pool Wiki page to learn what it takes to run a Rocket Pool node - and info on how to obtain RPL.

Check the Avado Rocket Pool page to learn what it takes to run a Rocket Pool node - and info on how to obtain RPL.

Please wait until your ETH1 node is synced

Expand Down Expand Up @@ -128,7 +129,7 @@ Click Yes to confirm
Warning
This should be an address you control (ex a MetaMask address). All of your RPL checkpoint rewards, your staked RPL, and your Beacon Chain ETH will be sent there when you claim your checkpoint rewards or exit your validator.

Please read the info on the wiki carefully before setting your withdrawal address!
Please read the info here carefully before setting your withdrawal address!

Copy paste your withdrawel address

Expand Down
75 changes: 75 additions & 0 deletions content/specials/authoring_content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: "Adding/Modifying content on Avado-docs"
---

The Avado docs website is built with [Hugo](https://gohugo.io/). You can find installation instructions at <https://gohugo.io/getting-started/installing/>

## Local builds
To test the website locally, run:
```
hugo server
```
By default, this will open a preview build at <http://localhost:1313>

{{< hint type=tip >}}
Run `hugo server --navigateToChanged` to automatically open the pages you are editing
{{< /hint >}}

## Theme

The theme is based on [GeekDocs](https://github.com/thegeeklab/hugo-geekdoc).

You can find a demo and the full documentation at <https://geekdocs.de>.

## Create a new page

Create a new MarkDown page and add following preamble at the start of the file
```
---
title: Create your DApp for the AVADO DAppstore
---
```
You can add a `weight: 30` parameter to influence the position in the table of contents.


[Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/)

## Authoring tips

* Hint boxes (tip, important):
* Examples: <https://geekdocs.de/shortcodes/hints/>
* Code: <https://github.com/thegeeklab/hugo-geekdoc/blob/main/exampleSite/content/en/shortcodes/hints.md>
* Short code:
```
{{</* hint type=tip title="optional" */>}}
**Markdown content**
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
{{</* /hint */>}}
```
* Images:
* Short code: `{{</* figure src="surge_strip.jpeg" */>}}`
* Parameters: <https://gohugo.io/content-management/shortcodes/#figure>
* To add the files: create a folder with the same name as the page and store the images there.
* Table of Contents:
* Short code: `{{</* toc */>}}`
* YouTube
* Short code: `{{</* youtube w7Ft2ymGmfc */>}}`
* Doc: <https://gohugo.io/content-management/shortcodes/#example-youtube-input>
* icon-sets: https://geekdocs.de/features/icon-sets/

### Icons

* https://fontawesome.com/
* https://svgsprit.es/

### Link checking

Install [Broken-link-checker](https://github.com/stevenvachon/broken-link-checker):
```
npm install broken-link-checker -g
```

Run the checker: (local links only)
```
blc http://localhost:1313 --exclude-external --recursive --ordered
```
1 change: 1 addition & 0 deletions content/specials/docs-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ title: Report documentation issues
{{< button href="https://github.com/AvadoDServer/avado-docs/issues/new" >}}File the issue in our GitHub project{{< /button >}}


[How to add content?](../authoring_content)
2 changes: 1 addition & 1 deletion content/troubleshooting/move-eth2-validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ Step 4 - Now you MUST wait a minimum of 5 FINALIZED epochs before moving and imp

Step 5 – Once you have waited at least 5 FINALIZED epochs it’s the same process as when you originally setup your ETH2 validator, just in the NEW location.

Step 6 – From here you can follow the same instructions from the Avado wiki setting up ETH2 staking, start at Step 5.1
Step 6 – From here you can follow the same instructions from the Avado Docs for setting up ETH2 staking, start at Step 5.1

Reach out on [Telegram](/support/telegram/#staking-support) if you have questions.

0 comments on commit 5712500

Please sign in to comment.