Giter VIP home page Giter VIP logo

doc.teku's Introduction

doc.teku's People

Contributors

ajsutton avatar alexandratran avatar banteg avatar benjaminion avatar bgravenorst avatar cooganb avatar courtneyeh avatar dependabot[bot] avatar ermyas avatar ezzahhh avatar ianaz avatar jlazoff avatar joaniefromtheblock avatar joshuafernandes avatar jtraglia avatar ladidan avatar lucassaldanha avatar macfarla avatar madelinemurray avatar mbaxter avatar mehdi-aouadi avatar nicolasmassart avatar omahs avatar q9f avatar rojotek avatar rolandtyler avatar rolfyone avatar stefanbratanov avatar tbenr avatar zilm13 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

doc.teku's Issues

Update CLI options

  • Rename --validators-key-file to --validators-unencrypted-key-file
  • In a future release the --eth1-enabled option will be removed. ETH1 will be enabled when --eth1-endpoint is provided and otherwise disabled.
  • Add --rest-api-host-whitelist

Document YAML Configuration Options

The Teku configuration file is now YAML formatted.

Update the the Config option in the CLI options topic and add conceptual or how-to information.

Add content on the split of messages between console and log file

From @ajsutton:

Production deployments shouldn’t be using ‘both’ logging. For a production deployment either ‘console’ and then have something like systemd handle the output or at minimum ‘file’ logging is strongly recommended.
Actually @pliny-team would be really handy to add something to the docs on this to make clear that by default status updates go to the console but most of the information goes to the log file.

Document how to make deposits using Teku

Describe how to use the teku validator generate and teku validator register subcommands to generate/register validators and make deposits to an Eth1 deposit contract.

Make content about connecting to Eth1 more generic

Teku can now connect to an Infura Eth 1.0 endpoint. E.g
--eth1-endpoint=https://goerli.infura.io/v3/<your-api-key>)

Additionally, make it more clear to the user that they do not need to install Besu to run a Teku validator.

Add note about Teku chain spec versions

We’re in a slightly tricky period transitioning between beacon chain spec versions for Teku. It may be worth adding a note to our docs to indicate that:

  • master branch and v0.11.x builds are compatible with the 0.11.3 specification, including the witti multiclient testnet.
  • 0.12.1-integration branch and v0.12.x builds are compatible with the 0.12.1 specification, including Prysm’s new Onyx testnet. These are even more early access than usual as we haven’t completed testing of our v0.12 changes yet.

[Per Adrian]
My recommendation is that people use the master branch/0.11.x releases with the witti testnet.
A new multiclient testnet using spec version 0.12.1 will be launched in the next couple of weeks which is when we recommend people switch to our 0.12 builds (and we’ll likely merge the 0.12.1-integration branch into master at that point since witti will be shut down)

Add issue and PR templates

Add 2 issue templates:

  • Doc tool bug report
  • Doc content issue report

Add 2 PR templates:

  • Content pull request
  • DocOps pull request

See also PegaSysEng/Misc#67

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.