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.

Sign up for GitHub

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

Minor edits to dev journeys section titles and indexes #198

Open
wants to merge 2 commits into
base: staging
Choose a base branch
from
Open

Minor edits to dev journeys section titles and indexes #198

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6198f0e
rename first section in journeys to basics, minor edits
lparisc Jul 31, 2023
64c4bff
add fixes based on feedback
lparisc Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions native/02_core-concepts/10_blockchain-basics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@
title: Blockchain Basics
---

Before learning how to develop smart contracts, web applications, or run nodes, it is important to understand the basics
of blockchain technology. This section provides an overview of blockchain technology and the EOS blockchain.
Before learning how to develop smart contracts, web applications, or run nodes, it is important to understand the basics of blockchain technology. This section provides an overview of blockchain technology and the EOS blockchain.

* [Decentralization](./10_decentralization.md)
* [Consensus](./20_consensus.md)
* [Cryptography](./30_cryptography.md)
* [Transactions and Blocks](./40_transactions-and-blocks.md)
* [Smart Contracts](./50_smart-contracts.md)
* [Web3](./60_web3.md)
Select a topic within the Blockchain Basics section from the left navigation menu.
2 changes: 1 addition & 1 deletion ...03_smart-contracts/01_contract-anatomy.md → native/03_smart-contracts/01_basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Anatomy
title: Contract Basics
---

The most used Smart Contract development language for EOS is C++, sometimes referred to as `EOS++`.
Expand Down
23 changes: 8 additions & 15 deletions ..._web-applications/01_beginner-concepts.md → native/04_web-applications/01_basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
---
title: Beginner Concepts
title: Web App Basics
Copy link
Member

Choose a reason for hiding this comment

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

Don't need to re-state "Web app", it's already in the web app section

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed the "web app" phrase. Back in the day they asked to make sure the actual related topic appeared on the title, for indexing and search matching reasons. If the title is just "Basics" the indexer must somehow used context from the parent to figure out what basics it refers to - probably something a good search engine will do anyway. I was just making it easier for the indexer, although probably not needed, so removed.

---

<head>
<title>EOS dApps - Beginner Concepts</title>
</head>

A lot of tutorials for building decentralized web applications dive straight into the code but do not explain
the core conceptual differences between web2 development and web3 development.
A lot of tutorials for building decentralized web applications dive straight into the code but do not explain the core conceptual differences between web2 development and web3 development.

This guide will help you wrap your head around how decentralized applications work, what parts of the stack are
different, and how to think about the architecture of your decentralized applications.
This guide will help you wrap your head around how decentralized applications work, what parts of the stack are different, and how to think about the architecture of your decentralized applications.

## The blockchain comes packed with features

In traditional web2 development you need to roll your entire stack alone. Even if you use cloud providers like AWS,
you still need to pick and choose which services you want to use and how to integrate them together.
In traditional web2 development you need to roll your entire stack alone. Even if you use cloud providers like AWS, you still need to pick and choose which services you want to use and how to integrate them together.

In web3 development, the blockchain comes packed with every feature you need to build most applications.

Expand All @@ -32,8 +29,7 @@ In web3 development, the blockchain comes packed with every feature you need to

In web2 development, you need to build a backend to store data and perform business logic. This might be a REST API or serverless functions.

In web3 development, can interact directly with the blockchain. You don't need to run your own backend infrastructure, kube clusters, or serverless functions.
It is very similar to serverless functions, except that the functions are run on a decentralized blockchain instead of a centralized cloud provider.
In web3 development, you can interact directly with the blockchain. You don't need to run your own backend infrastructure, kube clusters, or serverless functions. It is very similar to serverless functions, except that the functions are run on a decentralized blockchain instead of a centralized cloud provider.

> ❔ **You might still want to run infrastructure**
>
Expand All @@ -43,19 +39,16 @@ It is very similar to serverless functions, except that the functions are run on

### In some cases a backend helps

There are some cases where you might want to run your own backend. For example, if you want to store data that is not on the blockchain, or if you want to
perform business logic that is either too expensive to run on the blockchain, or takes too long and exceeds the maximum time allowed for smart contract execution.
There are some cases where you might want to run your own backend. For example, if you want to store data that is not on the blockchain, or if you want to perform business logic that is either too expensive to run on the blockchain, or takes too long and exceeds the maximum time allowed for smart contract execution.

You might also want to provide your applications with different ways to access the data stored on the blockchain that is easier for you
to work with, like GraphQL or SQL queries. In that case you might want to build a backend that listens to the blockchain and stores the data you care about in a way that suits your needs.

## Get comfortable with wallets

A blockchain wallet is a piece of software that manages private keys.
Wallets do not store any blockchain data within them, instead they use the private keys they manage to sign transactions that manipulate the blockchain.
A blockchain wallet is a piece of software that manages private keys. Wallets do not store any blockchain data within them, instead they use the private keys they manage to sign transactions that manipulate the blockchain.

In web2 development, you need to build your own authentication system. You might use a third-party service like Auth0, or you might roll your own.
Once your user logs in, you rely on their session to prove that they are who they say they are.
In web2 development, you need to build your own authentication system. You might use a third-party service like Auth0, or you might roll your own. Once your user logs in, you rely on their session to prove that they are who they say they are.

You might add in additional security measures like 2FA, IP-user pairing, and a variety of other techniques.

Expand Down
0 ...eration/10_getting-started/00_software.md → ...7_node-operation/10_basics/00_software.md
View file
Open in desktop
File renamed without changes.
0 ...tting-started/10_hardware-requirements.md → ...ion/10_basics/10_hardware-requirements.md
View file
Open in desktop
File renamed without changes.
0 ...on/10_getting-started/20_configuration.md → ...e-operation/10_basics/20_configuration.md
View file
Open in desktop
File renamed without changes.
0 ...peration/10_getting-started/30_plugins.md → ...07_node-operation/10_basics/30_plugins.md
View file
Open in desktop
File renamed without changes.
0 ...peration/10_getting-started/40_peering.md → ...07_node-operation/10_basics/40_peering.md
View file
Open in desktop
File renamed without changes.
0 ...ration/10_getting-started/50_snapshots.md → ..._node-operation/10_basics/50_snapshots.md
View file
Open in desktop
File renamed without changes.
0 ...g-started/60_logging/10_native-logging.md → ...10_basics/60_logging/10_native-logging.md
View file
Open in desktop
File renamed without changes.
0 ...hird-party-logging/10_deep-mind-logger.md → ...hird-party-logging/10_deep-mind-logger.md
View file
Open in desktop
File renamed without changes.
0 ...rd-party-logging/20_prometheus-monitor.md → ...rd-party-logging/20_prometheus-monitor.md
View file
Open in desktop
File renamed without changes.
0 ...0_logging/20_third-party-logging/index.md → ...0_logging/20_third-party-logging/index.md
View file
Open in desktop
File renamed without changes.
0 ...on/10_getting-started/60_logging/index.md → ...e-operation/10_basics/60_logging/index.md
View file
Open in desktop
File renamed without changes.
0 ...on/10_getting-started/70_common-issues.md → ...e-operation/10_basics/70_common-issues.md
View file
Open in desktop
File renamed without changes.
11 changes: 11 additions & 0 deletions native/07_node-operation/10_basics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Getting Started
Copy link
Member

Choose a reason for hiding this comment

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

Is it meant to be getting started, or basics?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When learning a new technology you typically start with the basics, so I think they can be used interchangeably. Basics is more concise. I can change it back to getting started though, just let me know.

---

<head>
<title>Getting Started with Node Operation</title>
</head>

This section digs into the basic knowledge you need to run a node. All node operators (APIs, producers, history nodes, etc.) should know the information in this section.

Select a topic within the Node Operator section from the left navigation menu.
12 changes: 0 additions & 12 deletions native/07_node-operation/10_getting-started/index.md
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions native/60_advanced-topics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_class_name: sidebarhidden
---


## Core
## Core Layer

The `EOS Core` provides the basic building blocks for the `system` layer. However, since they are not implemented as smart contracts, they do not provide the same level of flexibility. Nevertheless, the `core` implementation is also open source, and thus it can be modified to suit custom business requirements.

Expand All @@ -14,7 +14,7 @@ The core protocols are:
2. [Transactions Protocol](02_transactions-protocol.md)
3. [Network or Peer to Peer Protocol](03_network-peer-protocol.md)

## System
## System Layer

The EOS blockchain is unique in that the features and characteristics of the blockchain built on it are flexible, that is, they can be changed or be modified completely to suit each business case requirement. Core blockchain features such as consensus, fee schedules, account creation and modification, token economics, block producer registration, voting, multi-sig, etc., are implemented inside smart contracts which are deployed on the blockchain built on the EOS blockchain. These smart contracts are referred to as `system contracts` and the layer as the `EOS system` layer, or simply the `system` layer.

Expand Down