Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New eth2 terms for the glossary #2015

Merged
merged 2 commits into from Dec 3, 2020
Merged

New eth2 terms for the glossary #2015

merged 2 commits into from Dec 3, 2020

Conversation

ryancreatescopy
Copy link
Contributor

Description

With the launch of the genesis block🚀, thought we should add some technical glossary terms for the eth2 stuff as they get used a lot!

@github-actions github-actions bot added needs review 👀 Review is needed for this issue or pull request content 🖋️ This involves copy additions or edits labels Dec 1, 2020
@ryancreatescopy
Copy link
Contributor Author

@djrtwo would be great if you could do a quick accuracy check on this for me! Also, if there are any other common terms you think we could add, that'd be awesome.

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@@ -34,10 +34,20 @@ In [Solidity](#solidity), `assert(false)` compiles to `0xfe`, an invalid opcode,

<DocLink to="/developers/docs/security/" title="Security" />

### attestation {#attestation}

A validator vote for a [Beacon Chain](#beacon-chain) or [shard](#shard) [block](#block). Validators must attest to blocks, signalling that they agree with the state proposed by the block.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I am correct, the spelling of "signalling" vs "signaling" is regional. We only have "en" without any differentiation for British vs American, but correct me if I'm wrong, words like "organization" vs "organisation" on the site tend to be the American spelling?
For consistency would suggest changing to signaling

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point, there's quite a mix of English (British vs. American) across the site. Probably makes sense to pick one to go with.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the best way to decide, e.g. if Google Trends data is an accurate signal of understanding/demand:
Image 2020-12-01 at 9 17 24 AM

@@ -144,6 +164,12 @@ A short string of data a user produces for a document using a [private key](#pri

A cryptographic algorithm used by Ethereum to ensure that funds can only be spent by their owners.

### epoch {#epoch}

A period of 32 [slots](#slot) (6.4 minutes) in the [Beacon Chain](#beacon-chain)-coordinated system. [Validator](#validator) [committees](#committee) are shuffled every epoch for security reasons. There's an opportunity at each epoch for the chain to be [finalised](#finality).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above here with "finalised"... would suggest changing to finalized

samajammin
samajammin previously approved these changes Dec 1, 2020
Copy link
Contributor

@samajammin samajammin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ryancreatescopy
Copy link
Contributor Author

It pained me to do it, but changed to US English. We also go the. thumbs up from Lakshman so let's merge after review.

@samajammin samajammin merged commit ec2618a into dev Dec 3, 2020
@samajammin samajammin deleted the eth2-glossary branch December 3, 2020 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits needs review 👀 Review is needed for this issue or pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants