Skip to content

Commit

Permalink
#1692 [Polkadot Guide Section: Initially Proposing to Exist on Gettin…
Browse files Browse the repository at this point in the history
…g Started Pages] (#2392)

* Add basic guide outline

* Add guide to sidebar

* Add guide images

* Add formatting to support dual images

* Update layout and style of guide

* Change to 'card' layout model

* Add Icons for each card

* Add images and basic titles

* Add additional cards and updated icons

* Change card background and transition

* Delete images that are repeated

* Add updated icons in black

* Add hover effect and box-shadow

* Add Guides Section

* Changed class names for clarity and consistency

* Change sidebar label

* Change order of cards, add/remove images

* Add stake card with image

* Remove images that are not needed

* temp

* update polkadot guide to temp live on getting started pages

* edits

Co-authored-by: Juan Diego <[email protected]>
Co-authored-by: Danny Salman <[email protected]>
  • Loading branch information
3 people authored Sep 9, 2021
1 parent 7035f10 commit 3f52125
Show file tree
Hide file tree
Showing 35 changed files with 2,217 additions and 97 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Feature Request
about: Suggest an idea for the Wiki
title: "[Feature Request]"
labels: docs
assignees: ''

assignees: ""
---

**Is your feature request related to a problem? Please describe.**
Expand Down
58 changes: 29 additions & 29 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ name: "CodeQL"

on:
push:
branches: [ master ]
branches: [master]
pull_request:
# The branches below must be a subset of the branches above
branches: [ master ]
branches: [master]
schedule:
- cron: '19 9 * * 2'
- cron: "19 9 * * 2"

jobs:
analyze:
Expand All @@ -32,40 +32,40 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
language: ["javascript"]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Checkout repository
uses: actions/checkout@v2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release
#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
22 changes: 11 additions & 11 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,6 @@ The servers will reflect the latest `master` commit or PR put up against the mas
The latest version of `master` is staged and checked by the team. If all is well, the new commits on `master` are transferred into the production branch,`prod`, by rebasing `master` on `prod`. The CICD production workflow will deploy `prod` to the public sites:
[Polkadot Wiki](https://wiki.polkadot.network) and [Kusama Guide](https://guide.kusama.network), respectively.


### Mirror Pages

A limitation of Docusaurus is that pages can only be included in one sidebar at any given time.
Expand Down
Binary file added docs/assets/guides/polkadot-guide/Account.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Ambassadors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Bridges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Council.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Identity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/guides/polkadot-guide/Kusama.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Network.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Parachain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Proposal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Stake.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Transfer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Treasury.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/Voting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/kusama.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/guides/polkadot-guide/network.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/build/build-node-interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ documentation for the tool you are using:
**Polkadot-JS RPC** is a JavaScript library for interacting with the **Substrate RPC API** endpoint, distributed as `@polkadot/api` Node.js package.
**Substrate API Sidecar** is using the **Polkadot-JS RPC** to provide separately runnable REST services.


## Polkadot RPC

The Parity Polkadot client exposes HTTP and WS endpoints for RPC connections. The default ports are
Expand Down
12 changes: 6 additions & 6 deletions docs/build/build-wallets.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ contact the developers of that wallet.

These are wallets which have been supported by either the Polkadot or Kusama Treasury via Treasury Proposal. Links in the Proposals section go to the Polkassembly post where the Treasury Proposal was discussed.

| Wallet Name | Proposals | Development State | Team Name | Description | Custody | Supports |
| --------------------------------------------- | ------------------------------------------------- | ----------------- | -------------- | ------------ | ------------- | -------- |
| [Fearless Wallet](https://fearlesswallet.io/) | [1](https://kusama.polkassembly.io/treasury/23), [2](https://kusama.polkassembly.io/treasury/34), [3](https://kusama.polkassembly.io/treasury/74), [4](https://kusama.polkassembly.io/treasury/102) | Live | SORAMITSU | iOS, Android | Non-custodial | Staking |
| [Klever](https://klever.io/) | [1](https://kusama.polkassembly.io/treasury/91) | Live | Klever | iOS, Android | Non-custodial | Staking |
| [Polkawallet](https://polkawallet.io/) | [1](https://kusama.polkassembly.io/treasury/32), [2](https://kusama.polkassembly.io/treasury/41) | Live | Polkawallet | iOS, Android | Non-custodial | Staking |
| [Stylo](https://stylo-app.com/) | [1](https://polkadot.polkassembly.io/treasury/39) | Live | Thibaut Sardan | Android | Non-custodial | Staking |
| Wallet Name | Proposals | Development State | Team Name | Description | Custody | Supports |
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------- | ------------ | ------------- | -------- |
| [Fearless Wallet](https://fearlesswallet.io/) | [1](https://kusama.polkassembly.io/treasury/23), [2](https://kusama.polkassembly.io/treasury/34), [3](https://kusama.polkassembly.io/treasury/74), [4](https://kusama.polkassembly.io/treasury/102) | Live | SORAMITSU | iOS, Android | Non-custodial | Staking |
| [Klever](https://klever.io/) | [1](https://kusama.polkassembly.io/treasury/91) | Live | Klever | iOS, Android | Non-custodial | Staking |
| [Polkawallet](https://polkawallet.io/) | [1](https://kusama.polkassembly.io/treasury/32), [2](https://kusama.polkassembly.io/treasury/41) | Live | Polkawallet | iOS, Android | Non-custodial | Staking |
| [Stylo](https://stylo-app.com/) | [1](https://polkadot.polkassembly.io/treasury/39) | Live | Thibaut Sardan | Android | Non-custodial | Staking |

> NOTE: these third-party wallets have been funded by the community through either the Polkadot or Kusama [Treasury](learn-treasury). **Web 3.0 Technologies Foundation does not endorse these wallets, and you should use your own due diligence in researching them.** The official Polkadot Support cannot provide support for issues with these wallets or other non-Parity developed wallets.
Expand Down
16 changes: 8 additions & 8 deletions docs/general/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,21 @@ For more information on the Polkadot roadmap please visit the

### How do I apply to be a validator?

There is no central authority that decides on validators, so there is not per se an *application*
There is no central authority that decides on validators, so there is not per se an _application_
that you can fill out. Registering as a validator is permissionless; in order to become one you must
only set up a validator node and mark your intention to validate on chain. For detailed instruction
on how to do this you can consult the
[Kusama validator guide](../maintain/kusama/maintain-guides-how-to-validate-kusama.md) on validating for Kusama or the
[Polkadot validator guide](../maintain/maintain-guides-how-to-validate-polkadot.md) for validating on Polkadot.

However, once you've set up a validator and have registered your intention it does not mean that you
will be included in the *active set* right away. The validators are elected to the active set based
will be included in the _active set_ right away. The validators are elected to the active set based
on the results of an election algorithm known as [Phragmén's method](../learn/learn-phragmen.md). Phragmén's
method tries to accomplish two goals: 1) select `n` members from a larger set based on
stake-weighted votes and 2) equalize the stake backing each validator as much as possible.

You will likely want to campaign your validator to the community in order to get more backing. You
are looking for *nominators* that will put up their tokens to increase the stake for your validator.
are looking for _nominators_ that will put up their tokens to increase the stake for your validator.
For validators who cannot acquire the minimum stake from the community, Parity and Web3 Foundation
also run a joint program called [Thousand Validators](thousand-validators.md) that will nominate
validators if they apply and fit the requirements.
Expand Down Expand Up @@ -104,7 +104,7 @@ similar PoS chains with comparable levels of economic security as Polkadot. The
are operating with around 150 validators, while Polkadot is already securely running with
{{ num_validators }}.

Additionally, other projects sometimes have a different definition of *validator* that approximates
Additionally, other projects sometimes have a different definition of _validator_ that approximates
more closely to remote signing keys without the full operation of a validating node. On Polkadot,
each validator is running their own validating node and performing full verification of the Relay
Chain, voting on finality, producing blocks in their decided slots, and verifying parachain state
Expand All @@ -131,13 +131,13 @@ No - and yes. The Polkadot Relay Chain does not implement smart contracts native
not having smart contracts on the Relay Chain is part of the design philosophy for Polkadot that
dictates that the Relay Chain should be the minimal logic required to accomplish its job.

However, Polkadot will be a platform for other chains that *do* implement smart contracts. It's
However, Polkadot will be a platform for other chains that _do_ implement smart contracts. It's
possible for parachains to enable smart contract functionality and then benefit from the security
and interoperability features of Polkadot. Additionally, existing smart contract chains can connect
to Polkadot as a parachain, or via a bridge.

While the Polkadot Relay Chain does not implement smart contracts directly, undoubtedly there will
be parachains that do. So it's better to say that the Polkadot *ecosystem* has smart contracts
be parachains that do. So it's better to say that the Polkadot _ecosystem_ has smart contracts
versus "Polkadot has smart contracts."

### How will the Polkadot Relay Chain connect to external chains in the ecosystem?
Expand Down Expand Up @@ -189,13 +189,13 @@ conviction to sway the progression of the protocol.
A savvy reader might have noticed that the answer to the previous question endowed the token holder
with the ultimate responsibility to ensure that Polkadot's governance does not fail. By following
the train of this assertion, one might assume that Polkadot's governance is susceptible to becoming
ruled by a few large token holders (called *whales* in trading parlance) and therefore become a mere
ruled by a few large token holders (called _whales_ in trading parlance) and therefore become a mere
plutocracy (rule of the rich).

There are several other mechanisms that are built-in to the governance system to resist this
plutocratic tendency. One of these mechanisms is called conviction voting, and imbues greater voting
power to token holders who are willing to lock their tokens on the protocol for longer lengths of
time. Longer lock-ups display *conviction* in a vote. Conviction voting could allow a highly
time. Longer lock-ups display _conviction_ in a vote. Conviction voting could allow a highly
determined minority to overrule the vote of an apathetic majority in certain situations. Another
mechanism is known as Adaptive Quorum Biasing. This makes proposals have a varying threshold for
approval or rejection based on what part of the governance protocol the proposal originated in. For
Expand Down
Loading

0 comments on commit 3f52125

Please sign in to comment.