Browse Source

Navigation restructure

feat/navigation-upgrade
Alejandro Criado-Pérez 3 years ago
parent
commit
fbc4f501eb
No known key found for this signature in database GPG Key ID: 766DF93C61C31C03
  1. 150
      next.config.js
  2. 57
      src/common/navigation.yaml
  3. 2
      src/pages/en/build-apps/deploy-tips.md
  4. 17
      src/pages/en/gaia/overview.md
  5. 0
      src/pages/en/nodes-and-miners/miner-mainnet.md
  6. 0
      src/pages/en/nodes-and-miners/miner-testnet.md
  7. 11
      src/pages/en/nodes-and-miners/overview.md
  8. 0
      src/pages/en/nodes-and-miners/running-mainnet-node.md
  9. 0
      src/pages/en/nodes-and-miners/running-testnet-node.md
  10. 0
      src/pages/en/nodes-and-miners/stacks-node-configuration.md
  11. 0
      src/pages/en/noteworthy-contracts/bns-contract.md
  12. 0
      src/pages/en/noteworthy-contracts/stacking-contract.md

150
next.config.js

@ -8,6 +8,41 @@ const withFonts = require('next-fonts');
async function redirects() { async function redirects() {
return [ return [
{
source: '/build-apps/references/gaia',
destination: '/gaia',
permanent: true,
},
{
source: '/gaia',
destination: '/gaia/overview',
permanent: true,
},
{
source: '/references/bns-contract',
destination: '/noteworthy-contracts/bns-contract',
permanent: true,
},
{
source: '/references/stacking-contract',
destination: '/noteworthy-contracts/stacking-contract',
permanent: true,
},
{
source: '/references/deploy-tips',
destination: '/build-apps/deploy-tips',
permanent: true,
},
{
source: '/references/stacks-node-configuration',
destination: '/nodes-and-miners/stacks-node-configuration',
permanent: true,
},
{
source: '/nodes-and-miners',
destination: '/nodes-and-miners/overview',
permanent: true,
},
{ {
source: '/contribute', source: '/contribute',
destination: '/contribute/overview', destination: '/contribute/overview',
@ -88,30 +123,34 @@ async function redirects() {
destination: 'https://stacks.js.org/', destination: 'https://stacks.js.org/',
permanent: true, permanent: true,
}, },
{ source: '/develop/profiles.html', destination: '/authentication/profiles', permanent: true }, {
source: '/develop/profiles.html',
destination: '/authentication/profiles',
permanent: true,
},
{ {
source: '/storage/overview.html', source: '/storage/overview.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/develop/storage.html', source: '/develop/storage.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/data-storage/storage-write-read', source: '/data-storage/storage-write-read',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/data-storage/storage-guide', source: '/data-storage/storage-guide',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/data-storage/overview', source: '/data-storage/overview',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
@ -126,32 +165,32 @@ async function redirects() {
}, },
{ {
source: '/storage/write-to-read.html', source: '/storage/write-to-read.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/develop/radiks-intro.html', source: '/develop/radiks-intro.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/develop/radiks-setup.html', source: '/develop/radiks-setup.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/develop/radiks-models.html', source: '/develop/radiks-models.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/develop/radiks-collaborate.html', source: '/develop/radiks-collaborate.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
source: '/develop/radiks-server-extras.html', source: '/develop/radiks-server-extras.html',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ {
@ -191,7 +230,7 @@ async function redirects() {
}, },
{ {
source: '/core/smart/testnet-node.html', source: '/core/smart/testnet-node.html',
destination: '/understand-stacks/running-testnet-node', destination: '/nodes-and-miners/running-testnet-node',
permanent: true, permanent: true,
}, },
{ {
@ -231,12 +270,12 @@ async function redirects() {
}, },
{ {
source: '/core/faq_technical.html', source: '/core/faq_technical.html',
destination: '/references/faqs', destination: '/',
permanent: true, permanent: true,
}, },
{ {
source: '/faqs/allfaqs', source: '/faqs/allfaqs',
destination: '/references/faqs', destination: '/',
permanent: true, permanent: true,
}, },
{ {
@ -344,18 +383,26 @@ async function redirects() {
destination: '/understand-stacks/atlas-usage', destination: '/understand-stacks/atlas-usage',
permanent: true, permanent: true,
}, },
{ source: '/org/overview.html', destination: '/ecosystem/overview', permanent: true }, {
source: '/org/overview.html',
destination: '/ecosystem/overview',
permanent: true,
},
{ {
source: '/faqs/allFAQS.html', source: '/faqs/allFAQS.html',
destination: '/references/faqs', destination: '/',
permanent: true, permanent: true,
}, },
{ {
source: '/core/faq_technical.html', source: '/core/faq_technical.html',
destination: '/references/faqs', destination: '/',
permanent: true,
},
{
source: '/org/token.html',
destination: '/ecosystem/stacks-token',
permanent: true, permanent: true,
}, },
{ source: '/org/token.html', destination: '/ecosystem/stacks-token', permanent: true },
{ {
source: '/org/whitepaper-blockchain.html', source: '/org/whitepaper-blockchain.html',
destination: 'https://community.stacks.org/pox', destination: 'https://community.stacks.org/pox',
@ -415,7 +462,7 @@ async function redirects() {
}, },
{ {
source: '/org/tokenholders.html', source: '/org/tokenholders.html',
destination: '/references/faqs/stacks-token', destination: '/',
permanent: true, permanent: true,
}, },
{ {
@ -513,10 +560,21 @@ async function redirects() {
destination: '/build-apps/overview', destination: '/build-apps/overview',
permanent: true, permanent: true,
}, },
{ source: '/org/terms.html', destination: '/references/glossary', permanent: true }, {
// overview redirects source: '/org/terms.html',
{ source: '/stacks-blockchain', destination: '/understand-stacks/overview', permanent: true }, destination: '/references/glossary',
{ source: '/smart-contracts', destination: '/write-smart-contracts/overview', permanent: true }, permanent: true,
},
{
source: '/stacks-blockchain',
destination: '/understand-stacks/overview',
permanent: true,
},
{
source: '/smart-contracts',
destination: '/write-smart-contracts/overview',
permanent: true,
},
{ {
source: '/understand-stacks', source: '/understand-stacks',
destination: '/understand-stacks/overview', destination: '/understand-stacks/overview',
@ -527,10 +585,10 @@ async function redirects() {
destination: '/write-smart-contracts/overview', destination: '/write-smart-contracts/overview',
permanent: true, permanent: true,
}, },
{ source: '/data-storage', destination: '/build-apps/references/gaia', permanent: true }, { source: '/data-storage', destination: '/gaia', permanent: true },
{ {
source: '/data-storage/overview', source: '/data-storage/overview',
destination: '/build-apps/references/gaia', destination: '/gaia',
permanent: true, permanent: true,
}, },
{ source: '/data-indexing', destination: '/build-apps/indexing/overview', permanent: true }, { source: '/data-indexing', destination: '/build-apps/indexing/overview', permanent: true },
@ -539,24 +597,44 @@ async function redirects() {
destination: '/build-apps/indexing/overview', destination: '/build-apps/indexing/overview',
permanent: true, permanent: true,
}, },
{ source: '/stacks-wallet', destination: '/stacks-wallet/overview', permanent: true }, {
{ source: '/naming-services', destination: '/build-apps/references/bns', permanent: true }, source: '/stacks-wallet',
{ source: '/naming-system', destination: '/build-apps/references/bns', permanent: true }, destination: '/stacks-wallet/overview',
{ source: '/storage-hubs', destination: '/storage-hubs/overview', permanent: true }, permanent: true,
},
{
source: '/naming-services',
destination: '/build-apps/references/bns',
permanent: true,
},
{
source: '/naming-system',
destination: '/build-apps/references/bns',
permanent: true,
},
{
source: '/storage-hubs',
destination: '/storage-hubs/overview',
permanent: true,
},
{ {
source: '/references', source: '/references',
destination: 'https://docs.hiro.so/references/stacks-cli', destination: 'https://docs.hiro.so/references/stacks-cli',
permanent: true, permanent: true,
}, },
{ source: '/ecosystem', destination: '/ecosystem/overview', permanent: true }, {
source: '/ecosystem',
destination: '/ecosystem/overview',
permanent: true,
},
{ {
source: '/stacks-blockchain/testnet-node', source: '/stacks-blockchain/testnet-node',
destination: '/understand-stacks/running-testnet-node', destination: '/nodes-and-miners/running-testnet-node',
permanent: true, permanent: true,
}, },
{ {
source: '/understand-stacks/testnet-node', source: '/understand-stacks/testnet-node',
destination: '/understand-stacks/running-testnet-node', destination: '/nodes-and-miners/running-testnet-node',
permanent: true, permanent: true,
}, },
{ {
@ -747,12 +825,12 @@ async function redirects() {
}, },
{ {
source: '/mining', source: '/mining',
destination: '/start-mining/mainnet', destination: '/nodes-and-miners/miner-mainnet',
permanent: true, permanent: true,
}, },
{ {
source: '/start-mining', source: '/start-mining',
destination: '/start-mining/mainnet', destination: '/nodes-and-miners/miner-mainnet',
permanent: true, permanent: true,
}, },
{ {
@ -792,7 +870,7 @@ async function redirects() {
}, },
{ {
source: '/stacks-blockchain/running-testnet-node', source: '/stacks-blockchain/running-testnet-node',
destination: '/understand-stacks/running-testnet-node', destination: '/nodes-and-miners/running-testnet-node',
permanent: true, permanent: true,
}, },
{ {

57
src/common/navigation.yaml

@ -15,12 +15,7 @@ sections:
- path: /stacking - path: /stacking
- path: /technical-specs - path: /technical-specs
- path: /stacks-blockchain-api - path: /stacks-blockchain-api
sections: # Add a page on governance/SIPs
- title: Tutorials
usePageTitles: true
pages:
- path: /running-mainnet-node
- path: /running-testnet-node
- path: /write-smart-contracts - path: /write-smart-contracts
usePageTitles: true usePageTitles: true
@ -56,38 +51,51 @@ sections:
- path: /build-apps - path: /build-apps
pages: pages:
- path: /overview - path: /overview
- path: /deploy-tips
sections: sections:
- title: References - title: References
usePageTitles: true usePageTitles: true
pages: pages:
- path: /references/authentication - path: /references/authentication
- path: /references/bns - path: /references/bns
- path: /references/gaia
- title: Community
usePageTitles: true
pages:
- external:
href: 'https://github.com/friedger/awesome-stacks-chain'
title: Awesome Stacks
- external: - external:
href: 'https://docs.hiro.so/example-apps' href: 'https://docs.hiro.so/example-apps'
title: Hiro example apps title: Hiro example apps
- path: /start-mining - path: /nodes-and-miners
pages: pages:
- path: /mainnet - path: /overview
- path: /testnet - path: /stacks-node-configuration
sections:
- title: Nodes
usePageTitles: true
pages:
- path: /running-mainnet-node
- path: /running-testnet-node
- title: Miners
usePageTitles: true
pages:
- path: /miner-mainnet
- path: /miner-testnet
- path: /noteworthy-contracts
pages:
- path: /bns-contract
- path: /stacking-contract
# Add more important contracts
- path: /gaia
pages:
- path: /overview
- path: /references - path: /references
pages: pages:
- path: /faqs
- path: /glossary - path: /glossary
- path: /deploy-tips
- external: - external:
href: 'https://hirosystems.github.io/stacks-blockchain-api/' href: 'https://hirosystems.github.io/stacks-blockchain-api/'
title: Stacks Blockchain API title: Stacks Blockchain API
- path: /stacks-node-configuration
- external: - external:
href: 'https://stacks.js.org/' href: 'https://stacks.js.org/'
title: Stacks.js title: Stacks.js
@ -97,12 +105,9 @@ sections:
- external: - external:
href: 'https://www.stacks.co/explore/discover-apps' href: 'https://www.stacks.co/explore/discover-apps'
title: Discover Apps title: Discover Apps
sections: - external:
- title: Contracts href: 'https://github.com/friedger/awesome-stacks-chain'
usePageTitles: true title: Awesome Stacks
pages:
- path: /bns-contract
- path: /stacking-contract
- path: /contribute - path: /contribute
pages: pages:

2
src/pages/en/references/deploy-tips.md → src/pages/en/build-apps/deploy-tips.md

@ -50,4 +50,4 @@ Consult the documentation for your hosting service to learn how to configure COR
## Deployment and Radiks ## Deployment and Radiks
If you are deploying a Stacks application that uses Radiks, your deployment includes a server and a database component. You must take this into account when deploying your application. You may want to choose a service such as Heroku or Digital Ocean if your app uses Radiks. If you are deploying a Stacks application that uses [Radiks](https://github.com/stacks-network/radiks), your deployment includes a server and a database component. You must take this into account when deploying your application. You may want to choose a service such as [Heroku](https://www.heroku.com) or [Digital Ocean](https://www.digitalocean.com) if your app uses Radiks.

17
src/pages/en/build-apps/references/gaia.md → src/pages/en/gaia/overview.md

@ -1,5 +1,5 @@
--- ---
title: Gaia title: Gaia overview
description: Decentralized storage architecture for off-chain data description: Decentralized storage architecture for off-chain data
images: images:
large: /images/pages/data-storage.svg large: /images/pages/data-storage.svg
@ -8,14 +8,11 @@ images:
## Introduction ## Introduction
Apps built with the Stacks blockchain store off-chain data using a storage system called Apps built with the Stacks blockchain store off-chain data using a storage system called Gaia.
Gaia.
Whereas public transactional metadata is best stored on the Stacks blockchain, user Whereas public transactional metadata is best stored on the Stacks blockchain, user application data can often be stored more efficiently and privately in Gaia storage.
application data can often be stored more efficiently and privately in Gaia storage.
Storing data off of the blockchain ensures that Stacks applications can provide users with high performance and high availability for data reads and writes without introducing central trust Storing data off of the blockchain ensures that Stacks applications can provide users with high performance and high availability for data reads and writes without introducing central trust parties.
parties.
## Understand Gaia in the Stacks architecture ## Understand Gaia in the Stacks architecture
@ -39,8 +36,7 @@ The Stacks blockchain stores only identity data. Data created by the actions of
## User control or how is Gaia decentralized? ## User control or how is Gaia decentralized?
A Gaia hub runs as a service which writes to data storage. The storage itself is a simple key-value store. The hub service A Gaia hub runs as a service which writes to data storage. The storage itself is a simple key-value store. The hub service writes to data storage by requiring a valid authentication token from a requestor. Typically, the hub service runs on a compute resource and the storage itself on separate, dedicated storage resource. Typically, both resources belong to the same cloud computing provider.
writes to data storage by requiring a valid authentication token from a requestor. Typically, the hub service runs on a compute resource and the storage itself on separate, dedicated storage resource. Typically, both resources belong to the same cloud computing provider.
![Gaiastorage](/images/gaia-storage.png) ![Gaiastorage](/images/gaia-storage.png)
@ -75,8 +71,7 @@ The token ensures the app has the authorization to write to the hub on the user'
## Gaia versus other storage systems ## Gaia versus other storage systems
Here's how Gaia stacks up against other decentralized storage systems. Features Here's how Gaia stacks up against other decentralized storage systems. Features that are common to all storage systems are omitted for brevity.
that are common to all storage systems are omitted for brevity.
| Features | [Gaia](https://github.com/stacks-network/gaia) | [Sia](https://sia.tech/) | [Storj](https://storj.io/) | [IPFS](https://ipfs.io/) | [DAT](https://datproject.org/) | [SSB](https://www.scuttlebutt.nz/) | | Features | [Gaia](https://github.com/stacks-network/gaia) | [Sia](https://sia.tech/) | [Storj](https://storj.io/) | [IPFS](https://ipfs.io/) | [DAT](https://datproject.org/) | [SSB](https://www.scuttlebutt.nz/) |
| ------------------------------------------ | ---------------------------------------------- | ------------------------ | -------------------------- | ------------------------ | ------------------------------ | ---------------------------------- | | ------------------------------------------ | ---------------------------------------------- | ------------------------ | -------------------------- | ------------------------ | ------------------------------ | ---------------------------------- |

0
src/pages/en/start-mining/mainnet.md → src/pages/en/nodes-and-miners/miner-mainnet.md

0
src/pages/en/start-mining/testnet.md → src/pages/en/nodes-and-miners/miner-testnet.md

11
src/pages/en/nodes-and-miners/overview.md

@ -0,0 +1,11 @@
---
title: Overview
description: Nodes and Miners
icon: BlockstackIcon
---
Here are all the steps to run nodes and miners, both on mainnet and testnet.
## What's a Stacks node?
## What's a Stacks miner?

0
src/pages/en/understand-stacks/running-mainnet-node.md → src/pages/en/nodes-and-miners/running-mainnet-node.md

0
src/pages/en/understand-stacks/running-testnet-node.md → src/pages/en/nodes-and-miners/running-testnet-node.md

0
src/pages/en/references/stacks-node-configuration.md → src/pages/en/nodes-and-miners/stacks-node-configuration.md

0
src/pages/en/references/bns-contract.md → src/pages/en/noteworthy-contracts/bns-contract.md

0
src/pages/en/references/stacking-contract.md → src/pages/en/noteworthy-contracts/stacking-contract.md

Loading…
Cancel
Save