Skip to content

Commit

Permalink
Rebooting the nice website with docs (#204)
Browse files Browse the repository at this point in the history
* Rebooting the nice website with docs

* more updates

* Optimised images with calibre/image-actions

* forgot to remove coc

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
AnomalRoil and github-actions[bot] authored Dec 15, 2024
1 parent 3062048 commit f9e10f0
Show file tree
Hide file tree
Showing 38 changed files with 4,752 additions and 2,804 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Drand documentation
# drand documentation

Welcome to the drand documentation website! The live site can be found at https://drand.love.

Expand Down Expand Up @@ -55,5 +55,4 @@ _Note_: You'll need to use NodeJS version 16, e.g. 16.19.1. At the moment, NodeJ
Always test that you blog post is displaying correctly before merging anything into `master`.

## Deployment to drand.love
Commits on master automatically deploy the updated website to https://drand.love using [Fleek](https://fleek.co/). Commits on side branches provide a preview build in their `fleek/build` check.
See [this entry](https://docs.fleek.co/hosting/site-deployment/) in Fleek's documentation for more details on how that happens.
Commits on master automatically deploy the updated website to https://drand.love using Cloudflare Pages. Commits on side branches provide a preview build.
7 changes: 3 additions & 4 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ module.exports = {
locales: {
'/': {
lang: 'en-US',
title: 'Drand - Distributed Randomness Beacon.',
description: 'Drand Documentation'
title: 'drand - Distributed Randomness Beacon.',
description: 'drand Documentation'
}
},
markdown: {
Expand All @@ -28,7 +28,7 @@ module.exports = {
search: true,
searchMaxSuggestions: 10,
author: {
name: 'Drand Team',
name: 'drand Team',
twitter: ''
},
keywords:
Expand Down Expand Up @@ -88,7 +88,6 @@ module.exports = {
title: 'About',
path: '/about/'
},
'code-of-conduct',
'community',
'contributing',
{
Expand Down
10 changes: 6 additions & 4 deletions docs/.vuepress/nav/en.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ module.exports = [
]
},
{ text: 'Partner With Us', link: '/partner-with-us/' },
{ text: 'Press', link: '/press/' },
{ text: 'Blog', link: '/blog/' },
// {
// text: "We're hiring",
// link: 'https://boards.greenhouse.io/protocollabs/jobs/4283635004'
// }
{ text: 'Other Randamu Creations', link: 'https://randa.mu/' }
// {
// text: "We're hiring",
// link: 'https://boards.greenhouse.io/protocollabs/jobs/4283635004'
// }
]
Binary file added docs/.vuepress/public/images/loe/logo-dia.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 3 additions & 24 deletions docs/.vuepress/theme/components/LoE.vue
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,6 @@
<a href="https://chainsafe.io/" class="logo" title="ChainSafe">
<img src="/images/loe/logo-chainsafe.svg" alt="ChainSafe logo" />
</a>
<a href="http://clabs.org/" class="logo" title="cLabs">
<img
src="/images/loe/logo-clabs.png"
alt="cLabs logo"
class="wide"
/>
</a>
<a href="https://cloudflare.com/" class="logo" title="Cloudflare">
<img
src="/images/loe/logo-cloudflare.svg"
Expand Down Expand Up @@ -68,6 +61,9 @@
alt="Emerald Onion logo"
/>
</a>
<a href="https://www.diadata.org/" class="logo" title="DIA">
<img src="/images/loe/logo-dia.png" alt="DIA logo" />
</a>
<a
href="https://ethereum.foundation/"
class="logo"
Expand All @@ -78,9 +74,6 @@
alt="Ethereum Foundation logo"
/>
</a>
<a href="https://www.initc3.org/" class="logo" title="IC3">
<img src="/images/loe/logo-ic3.png" alt="IC3 logo" />
</a>
<a
href="https://www.kudelskisecurity.com/"
class="logo"
Expand All @@ -95,23 +88,9 @@
<a href="https://protocol.ai/" class="logo" title="Protocol Labs">
<img src="/images/loe/logo-pl.svg" alt="Protocol Labs logo" />
</a>
<a href="https://ptisp.pt/" class="logo" title="PTisp">
<img
src="/images/loe/logo-ptisp.png"
alt="PTisp logo"
class="wide"
/>
</a>
<a href="https://theqrl.org/" class="logo" title="QRL">
<img src="/images/loe/logo-qrl.svg" alt="QRL logo" class="narrow" />
</a>
<a href="https://tierion.com/" class="logo" title="Tierion">
<img
src="/images/loe/logo-tierion.svg"
alt="Tierion logo"
class="wide"
/>
</a>
<a
href="https://www.uchile.cl/"
class="logo"
Expand Down
30 changes: 12 additions & 18 deletions docs/.vuepress/theme/components/PartnerLogos.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,13 @@
class="wide"
/>
</a>
<a href="https://www.zengo.com/" class="logo" title="ZenGo">
<img src="/images/loe/logo-zengo.png" alt="ZenGo logo" class="wide" />
</a>
<a
href="https://ethereum.foundation/"
class="logo"
title="Ethereum Foundation"
>
<img src="/images/loe/ef-logo.png" alt="Ethereum Foundation logo" />
</a>
<a href="https://tierion.com/" class="logo" title="Tierion">
<img
src="/images/loe/tierion-logo.png"
alt="Tierion logo"
class="wide"
/>
</a>
<a
href="https://www.kudelskisecurity.com/"
class="logo"
Expand All @@ -43,16 +33,20 @@
class="wide"
/>
</a>
<a href="http://clabs.org/" class="logo" title="cLabs">
<a href="https://theqrl.org/" class="logo" title="QRL">
<img src="/images/loe/logo-qrl.svg" alt="QRL logo" class="narrow" />
</a>
<a
href="https://www.ata.network/"
class="logo"
title="Automata Network"
>
<img
src="/images/loe/c-labs-logo.png"
alt="cLabs logo"
src="/images/loe/ata-network.png"
alt="Automata Network logo"
class="wide"
/>
</a>
<a href="https://theqrl.org/" class="logo" title="QRL">
<img src="/images/loe/logo-qrl.svg" alt="QRL logo" class="narrow" />
</a>
<a
href="https://www.uchile.cl/"
class="logo"
Expand Down Expand Up @@ -80,8 +74,8 @@
alt="Centre for Digital Trust logo"
/>
</a>
<a href="https://ptisp.pt/" class="logo last-row" title="PTisp">
<img src="/images/loe/logo-ptisp.png" alt="PTisp logo" class="wide" />
<a href="https://www.diadata.org/" class="logo" title="DIA">
<img src="/images/loe/logo-dia.png" alt="DIA logo" />
</a>
<a
href="https://www.epfl.ch/labs/dedis/"
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/theme/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Drand Docs theme
// drand Docs theme

module.exports = {
extend: '@vuepress/theme-default'
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Drand documentation
title: drand documentation
description: The home page for developer documentation for drand, a distributed randomness beacon.
home: true
heroImage: images/logo-drand-text-bottom-dark.svg
Expand All @@ -23,7 +23,7 @@ features:

## Learn more

Billions of devices around the world use random numbers to keep computers secure and keep the internet open. High-grade random number generators need to be unpredictable, publicly verifiable, bias-resistant, decentralized, and always available. Drand strives to meet all these criteria while keeping things simple and accessible. [Find out more about how drand produces random numbers and how the team are making the project secure →](/docs/overview/)
Billions of devices around the world use random numbers to keep computers secure and keep the internet open. High-grade random number generators need to be unpredictable, publicly verifiable, bias-resistant, decentralized, and always available. drand strives to meet all these criteria while keeping things simple and accessible. [Find out more about how drand produces random numbers and how the team are making the project secure →](/docs/overview/)

## Get involved

Expand Down
21 changes: 16 additions & 5 deletions docs/about/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ title: About
---

Drand (pronounced "dee-rand") is a distributed randomness beacon daemon written
drand (pronounced "dee-rand") is a distributed randomness beacon daemon written
in Golang. Servers running drand can be linked with each other to produce
collective, publicly verifiable, unbiased, unpredictable random values at fixed
intervals using bilinear pairings and threshold cryptography.

Drand is meant to be an Internet infrastructure level service that provides
drand is meant to be an Internet infrastructure level service that provides
randomness to applications, similar to how NTP provides timing information and
Certificate Transparency logs provide certificate issuance information for free.

Expand All @@ -37,7 +37,7 @@ the given epoch. Decentralization helps for the liveness of the beacon.

## Origins of drand

Drand's development originally started in 2017 at the [DEDIS](https://dedis.ch)
drand's development originally started in 2017 at the [DEDIS](https://dedis.ch)
lab at [EPFL](https://epfl.ch) by Nicolas GAILLY, a PhD student at the time
with the help of Philipp Jovanovic and under the supervision of Bryan Ford.

Expand Down Expand Up @@ -74,7 +74,7 @@ using pairings.

Thanks to the use of pairing based cryptography, drand is able to generate verifiable
randomness in a very simple and efficient manner and to deliver it in a reliable
way to the clients. Drand was meant to be from the ground up a distributed
way to the clients. drand was meant to be from the ground up a distributed
service providing public randomness in an application-agnostic, secure, and
efficient way. And _nothing else_. The idea is that instead of having each
decentralized systems re-inventing the wheel internally, often poorly, drand would
Expand Down Expand Up @@ -108,6 +108,17 @@ decryption key oracle for timelock encryption, is used in a RNG certified by
Gaming Labs International for several lottery games, sortitions in various settings,
and more!

In 2024, the drand project is stewarded by the team at [Randamu](https://randa.mu/), and has deployed 3
different mainnet networks:
- the `default` chained one, launched in 2020 with a frequency of 30s and signatures on G2,
and beacons linked to the previous ones, not compatible with Timelock encryption;
- the `quicknet` unchained network, launched in 2023 with a period of only 3 seconds and
with signatures on G1. This one is fully compatible with Timelock encryption;
- the `evmnet` unchained network, launched in 2024, with a period of 3 seconds and signatures on G1,
but using the BN254 curve instead of the BLS12-381, in order to
be compatible with the EVM pre-compiles meant for BN254 only. This network allows
to verify the randomness on EVM-compatible chains directly on-chain.

## Acknowledgments

Thanks to [@herumi](https://github.com/herumi)for providing support on his
Expand All @@ -125,5 +136,5 @@ Finally, two special notes:
project and providing the push to make drand a production ready network.

:::tip Get in touch
If you have any questions or comments, you can reach the Drand team at [[email protected]](mailto:[email protected]) or join the [drand slack workspace](https://join.slack.com/t/drandworkspace/shared_invite/zt-19u4rf6if-bf7lxIvF2zYn4~TrBwfkiA).
If you have any questions or comments, you can reach the drand team at [[email protected]](mailto:[email protected]) or join the [drand slack workspace](https://join.slack.com/t/drandworkspace/shared_invite/zt-19u4rf6if-bf7lxIvF2zYn4~TrBwfkiA).
:::
71 changes: 0 additions & 71 deletions docs/about/code-of-conduct.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/about/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ description: Join in with the drand community!

# Community

The drand project is still in it's early stages, and we're building ways to interact with the community as we continue to build everything. In the next few weeks we'll open up a forum and IRC channel for public discussion.
The drand project is still in it's early stages, and we're building ways to interact with the community as we continue to build everything.

## GitHub
## GitHub & Slack

For now, the best way to join in with the community is [through GitHub](https://github.com/drand).
For now, the best way to join in with the community is [through GitHub](https://github.com/drand) or our [drand slack workspace](https://join.slack.com/t/drandworkspace/shared_invite/zt-19u4rf6if-bf7lxIvF2zYn4~TrBwfkiA).

## Mailing list

We now have an announcement mailing list for all Leauge of Entropy users. This mailing list is meant to announce any changes impacting Drand users downstream and is written and maintained by a League of Entropy secretariat. You can join the mailing list by visiting [groups.google.com/g/leagueofentropy-users](https://groups.google.com/g/leagueofentropy-users).
We now have an announcement mailing list for all Leauge of Entropy users. This mailing list is meant to announce any changes impacting drand users downstream and is written and maintained by a League of Entropy secretariat. You can join the mailing list by visiting [groups.google.com/g/leagueofentropy-users](https://groups.google.com/g/leagueofentropy-users).
Loading

0 comments on commit f9e10f0

Please sign in to comment.