documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Clean up and simplify the "Running a Chainlink Node" page.

Open dwightjl opened this issue 4 years ago • 11 comments

View staged changes here: https://deploy-preview-192--dreamy-villani-0e9e5c.netlify.app/docs/running-a-chainlink-node

  • Fix a broken docker inspect --format example. The format contents disappeared because they were in {{ }} brackets, which Liquid interpets as Liquid tags even within markdown codeblocks. See the currently published example: https://docs.chain.link/docs/running-a-chainlink-node/#ethereum-client-on-the-same-machine
  • Simplify the "Set your Ethereum Client URL" process to require fewer steps and reference fewer other sections in the document, which consolidates the steps in one section.
  • Rewrite the requirements section and include network requirements that were previously documented in a callout box.
  • Remove environment variable steps and ask the user to edit the .env variables directly. This reduces the complexity of the process but shifts more work to the user.
  • Clean up several formatting mistakes.
  • Correct errors in dependency guides for running external DBs and ETH clients.

dwightjl avatar Jul 01 '21 18:07 dwightjl

I restored the Docker recommendation section. Previously I had moved it to the Requirements section because it seemed redundant with the Docker-CE requirement, but if you want the Docker requirement to be more prominent we can keep the full Docker section.

dwightjl avatar Jul 01 '21 18:07 dwightjl

✔️ Deploy Preview for dreamy-villani-0e9e5c ready!

🔨 Explore the source changes: 8a8054394b803bed9f5d7cddb60b316a72bc2885

🔍 Inspect the deploy log: https://app.netlify.com/sites/dreamy-villani-0e9e5c/deploys/6196ff518a19000007de2922

😎 Browse the preview: https://deploy-preview-192--dreamy-villani-0e9e5c.netlify.app

netlify[bot] avatar Jul 12 '21 17:07 netlify[bot]

These fixes are still relevant. Re-synced and ready to merge.

dwightjl avatar Jul 22 '21 01:07 dwightjl

Updated to track the latest changes in main. See the PR description for the current list of changes.

dwightjl avatar Aug 16 '21 03:08 dwightjl

Can we just have "running from docker" be above "running from source"? And then make it clear that the rest of the doc is going to be running from docker.

PatrickAlphaC avatar Sep 09 '21 14:09 PatrickAlphaC

https://deploy-preview-192--dreamy-villani-0e9e5c.netlify.app/docs/running-a-chainlink-node/#create-an-environment-file

This section is still confusing to me.

Can we have sections for adding the 2 variables:

ETH_URL=ws://[CONTAINER_IP]:[CONTAINER_PORT]
DATABASE_URL=postgresql://[DB_USER]:[DB_PW]@[DB_IP]:[DB_PORT]/[DB_NAME]?sslmode=[SSL_MODE]

Like we had before? Like something like "now add your ETH_URL, you can do it one of 3 ways. If you're runing your own, do it like ws://[CONTAINER_IP]:[CONTAINER_PORT], if you're using an external URL, do it like this: ...."

Does that make sense?

PatrickAlphaC avatar Sep 09 '21 14:09 PatrickAlphaC

For Start the Chainlink Node, we should tell them that a decent version is 0.10.10

PatrickAlphaC avatar Sep 09 '21 14:09 PatrickAlphaC

@PatrickAlphaC I rewrote significant parts of the document and split up the ETH client steps from the DB config steps. I also added 0.10.10 as a recommended version.

The whole document has significant changes since you last reviewed, and some additional pages are also changed.

dwightjl avatar Sep 15 '21 04:09 dwightjl

Sorry, going to need another day or 2 to review.

PatrickAlphaC avatar Sep 16 '21 11:09 PatrickAlphaC

Could we add something in here about using an external service for the ETH_URL? That still seems lacking to me. During the Set the Ethereum Client URL and Port. I think ideally there is a part that's like "If you're using an external service, just add the websocket URL in the .env like so:"

PatrickAlphaC avatar Oct 13 '21 21:10 PatrickAlphaC

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
documentation ✅ Ready (Inspect) Visit Preview Sep 21, 2022 at 1:42AM (UTC)

vercel[bot] avatar Sep 18 '22 19:09 vercel[bot]