Files

mergify[bot] 3c67f71695 Deprecate commitment variants (bp #14797 ) (#14858 )

* Deprecate commitment variants (#14797)

* Deprecate commitment variants

* Add new CommitmentConfig builders

* Add helpers to avoid allowing deprecated variants

* Remove deprecated transaction-status code

* Include new commitment variants in runtime commitment; allow deprecated as long as old variants persist

* Remove deprecated banks code

* Remove deprecated variants in core; allow deprecated in rpc/rpc-subscriptions for now

* Heavier hand with rpc/rpc-subscription commitment

* Remove deprecated variants from local-cluster

* Remove deprecated variants from various tools

* Remove deprecated variants from validator

* Update docs

* Remove deprecated client code

* Add new variants to cli; remove deprecated variants as possible

* Don't send new commitment variants to old clusters

* Retain deprecated method in test_validator_saves_tower

* Fix clippy matches! suggestion for BPF solana-sdk legacy compile test

* Refactor node version check to handle commitment variants and transaction encoding

* Hide deprecated variants from cli help

* Add cli App comments

(cherry picked from commit ffa5c7dcc8)

* Fix 1.5 stake-o-matic

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
Co-authored-by: Tyera Eulberg <tyera@solana.com>

2021-01-26 20:49:04 +00:00

.travis

Move from gitbook to docusaurus, build docs in Travis CI (#10970 )

2020-07-11 05:11:07 +00:00

art

Cleanup programming model doc (#10274 )

2020-05-27 16:18:11 -06:00

src

Deprecate commitment variants (bp #14797 ) (#14858 )

2021-01-26 20:49:04 +00:00

static

Retry inflation parameter update along with documentation updates (#12778 )

2020-10-12 13:10:57 -07:00

.eslintrc

Move from gitbook to docusaurus, build docs in Travis CI (#10970 )

2020-07-11 05:11:07 +00:00

.gitignore

Add package-lock.json to docs (#11200 )

2020-07-24 14:15:22 -06:00

babel.config.js

Move from gitbook to docusaurus, build docs in Travis CI (#10970 )

2020-07-11 05:11:07 +00:00

build-cli-usage.sh

CI: Use branch-versioned cargo throughout

2020-11-05 05:05:57 +00:00

build.sh

Report and bail on broken links (#13540 )

2020-11-11 17:46:24 -08:00

convert-ascii-to-svg.sh

Change transparent .svg to opaque .png (#11084 )

2020-07-15 21:35:18 +00:00

docusaurus.config.js

Report and bail on broken links (#13540 )

2020-11-11 17:46:24 -08:00

offline-cmd-md-links.sh

Docs: Update CLI offline cmds (#8548 )

2020-03-01 17:20:37 -07:00

package-lock.json

Report and bail on broken links (#13540 )

2020-11-11 17:46:24 -08:00

package.json

Report and bail on broken links (#13540 )

2020-11-11 17:46:24 -08:00

publish-docs.sh

fix doc redirects (#13709 )

2020-11-19 21:34:21 +00:00

README.md

Add security best practice sections (#14798 )

2021-01-26 08:53:54 -08:00

set-solana-release-tag.sh

Guard against bsd sed (#13735 )

2020-11-21 17:56:23 -08:00

sidebars.js

docs: Add stake programming documentation (#14529 ) (#14582 )

2021-01-14 16:17:25 +00:00

README.md

Docs Readme

Solana's Docs are built using Docusaurus 2 with npm. Static content delivery is handled using vercel.

Installing Docusaurus

$ npm install

Local Development

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. (You might have to run build.sh first if you run into failures)

$ npm run start

Build Locally

This command generates static content into the build directory and can be served using any static contents hosting service.

$ docs/build.sh

CI Build Flow

The docs are built and published in Travis CI with the docs/build.sh script. On each PR, the docs are built, but not published.

In each post-commit build, docs are built and published using vercel to their respective domain depending on the build branch.

Master branch docs are published to edge.docs.solana.com
Beta branch docs are published to beta.docs.solana.com
Latest release tag docs are published to docs.solana.com