Skip to content

Update Getting started - Software overview with Lightning content #473

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

Merged
merged 37 commits into from
Sep 17, 2021

Conversation

danielnordh
Copy link
Contributor

@danielnordh danielnordh commented Sep 13, 2021

A Bitcoin [node]({{ '/guide/glossary/node/' | relative_url }}) is simply a computer running software, like [Bitcoin Core]({{ '/guide/glossary/#bitcoin-core-client'}}) connecting in to the Bitcoin network. Nodes verify transaction data on the Bitcoin blockchain and ensure the Bitcoin rules are being followed by network participants. Some wallets have built-in nodes, and some node software comes packaged with wallet functionality. However, the minimum implementation of a Bitcoin node is syncing data and allowing other software a user has to access it.

A Lightning node is a device running software connecting it to the Lightning network, which extends Bitcoin with payment channels to improve transaction speed and lower costs. It is becoming widely adopted and accepted as the preferred way to scale Bitcoin.
It’s common to use node management software. This simplifies the setup, management and monitoring of nodes by providing graphical user interfaces to interact with the lower level node software instead of CLIs.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would dedicate a whole section to this and go into the nuances of how one can operate their node (personal, merchant, routing node for example). Whole lot of detail here that is missing imo.

Copy link
Contributor Author

@danielnordh danielnordh Sep 14, 2021

Choose a reason for hiding this comment

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

None of the other sections go into that much detail about HOW to run the software.
If others agree we should cover the details, then let's review if we should have a separate 'Node management' section. Or if this should be a separate 'how to run and manage your own Lightning node' page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now I separated the node management info into its own paragraph in f593a43.

Copy link
Contributor

Choose a reason for hiding this comment

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

Whole section as in a separate guide section or page? We have the node page in the glossary already, and I agree with Daniel to keep this overview page light. People can click through to read more.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Lightning node software and Lightning node management software are two distinct categories. Not saying go into great detail but I think it's relevant enough to have its own section on this page. Later on we could have a dedicated page that goes into the different node operation modes in detail similar to how we have a node page in the glossary.

Copy link
Collaborator

@Bosch-0 Bosch-0 left a comment

Choose a reason for hiding this comment

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

Looking good, left comments :)

danielnordh and others added 6 commits September 14, 2021 10:27
Co-authored-by: bosch <55287964+Bosch-0@users.noreply.github.com>
Co-authored-by: bosch <55287964+Bosch-0@users.noreply.github.com>
Co-authored-by: bosch <55287964+Bosch-0@users.noreply.github.com>
Co-authored-by: bosch <55287964+Bosch-0@users.noreply.github.com>
@Bosch-0
Copy link
Collaborator

Bosch-0 commented Sep 15, 2021

I think that image separating one category from the other two is not visually pleasant

Agree with Pav, this image is visually displayed differently on mobile as the image isn't at the top of the body text.

@danielnordh
Copy link
Contributor Author

I think that image separating one category from the other two is not visually pleasant

Agree with Pav, this image is visually displayed differently on mobile as the image isn't at the top of the body text.

I'm guessing you are referring to the 'Explorers' image now being full-width instead of square and inline?
With the Lightning screen in I thought it was a bit hard to read at the smaller size, but I can change it if you think it's better.

The CLI image was/is already full width so if we do we should change both

@pavlenex
Copy link
Contributor

@danielnordh What I meant is that this sentence should be in the next line, this way
Screenshot 2021-09-15 at 10 53 19
So it's aligned to the image, and also suggest bullet list for these for better readability, but this isn't critical to me, mainly a suggestion.

@danielnordh
Copy link
Contributor Author

@danielnordh What I meant is that this sentence should be in the next line, this way
Screenshot 2021-09-15 at 10 53 19
So it's aligned to the image, and also suggest bullet list for these for better readability, but this isn't critical to me, mainly a suggestion.

Ah, got it, and agree. This was in the original text and I didn't touch it, but will attempt to clean up.

pavlenex
pavlenex previously approved these changes Sep 15, 2021
Copy link
Contributor

@pavlenex pavlenex left a comment

Choose a reason for hiding this comment

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

LGTM, I suggest we merge this when other PR's from the Milestone 7 get ready just so we have consistency in chapters.

@GBKS GBKS linked an issue Sep 17, 2021 that may be closed by this pull request
Co-authored-by: Christoph Ono <chri@sto.ph>
danielnordh and others added 4 commits September 17, 2021 10:58
Co-authored-by: Christoph Ono <chri@sto.ph>
Co-authored-by: Christoph Ono <chri@sto.ph>
Co-authored-by: Christoph Ono <chri@sto.ph>
Co-authored-by: Christoph Ono <chri@sto.ph>
Copy link
Contributor

@GBKS GBKS left a comment

Choose a reason for hiding this comment

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

Looks great. Thank you for doing this update.

@pavlenex pavlenex merged commit be69c59 into master Sep 17, 2021
@danielnordh danielnordh deleted the getting-started/software-overview-lightning branch September 23, 2021 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ⚡️ content to Getting Started > Software overview
4 participants