From 988a255146774e119d18f06308d143cc741334b5 Mon Sep 17 00:00:00 2001 From: Alexander Graebe Date: Mon, 21 Sep 2020 17:11:44 -0700 Subject: [PATCH] docs: add indexing to data storage fixing "data storage" part of #769 --- next.config.js | 38 ++++++++++++++++--- src/common/navigation.yaml | 18 +++++---- src/pages/build-an-app.md | 6 +-- .../indexing-collaborate.md} | 0 .../indexing-models.md} | 0 .../indexing-overview.md} | 7 +++- .../indexing-server-extras.md} | 2 +- .../integrate-indexing.md} | 10 ++++- 8 files changed, 62 insertions(+), 19 deletions(-) rename src/pages/{data-indexing/collaborate.md => data-storage/indexing-collaborate.md} (100%) rename src/pages/{data-indexing/models.md => data-storage/indexing-models.md} (100%) rename src/pages/{data-indexing/overview.md => data-storage/indexing-overview.md} (96%) rename src/pages/{data-indexing/server-extras.md => data-storage/indexing-server-extras.md} (99%) rename src/pages/{data-indexing/integrate.md => data-storage/integrate-indexing.md} (97%) diff --git a/next.config.js b/next.config.js index 41b7cf72..de33587f 100755 --- a/next.config.js +++ b/next.config.js @@ -48,27 +48,27 @@ async function redirects() { }, { source: '/develop/radiks-intro.html', - destination: '/data-indexing/overview', + destination: '/data-storage/indexing-overview', permanent: true, }, { source: '/develop/radiks-setup.html', - destination: '/data-indexing/integrate', + destination: '/data-storage/integrate-indexing', permanent: true, }, { source: '/develop/radiks-models.html', - destination: '/data-indexing/models', + destination: '/data-storage/indexing-models', permanent: true, }, { source: '/develop/radiks-collaborate.html', - destination: '/data-indexing/collaborate', + destination: '/data-storage/indexing-collaborate', permanent: true, }, { source: '/develop/radiks-server-extras.html', - destination: '/data-indexing/server-extras', + destination: '/data-storage/indexing-server-extras', permanent: true, }, { @@ -342,7 +342,7 @@ async function redirects() { { source: '/stacks-blockchain', destination: '/stacks-blockchain/overview', permanent: true }, { source: '/smart-contracts', destination: '/smart-contracts/overview', permanent: true }, { source: '/data-storage', destination: '/data-storage/overview', permanent: true }, - { source: '/data-indexing', destination: '/data-indexing/overview', permanent: true }, + { source: '/data-indexing', destination: '/data-storage/indexing-overview', permanent: true }, { source: '/stacks-wallet', destination: '/stacks-wallet/overview', permanent: true }, { source: '/naming-services', destination: '/naming-services/overview', permanent: true }, { source: '/storage-hubs', destination: '/storage-hubs/overview', permanent: true }, @@ -368,6 +368,32 @@ async function redirects() { destination: '/stacks-blockchain/atlas-usage', permanent: true, }, + // data indexing changes + { + source: '/data-indexing/overview', + destination: '/data-storage/indexing-overview', + permanent: true, + }, + { + source: '/data-indexing/integrate', + destination: '/data-storage/integrate-indexing', + permanent: true, + }, + { + source: '/data-indexing/models', + destination: '/data-storage/indexing-models', + permanent: true, + }, + { + source: '/data-indexing/collaborate', + destination: '/data-storage/indexing-collaborate', + permanent: true, + }, + { + source: '/data-indexing/server-extras', + destination: '/data-storage/indexing-server-extras', + permanent: true, + }, ]; } diff --git a/src/common/navigation.yaml b/src/common/navigation.yaml index 740ad4d5..160d4b73 100644 --- a/src/common/navigation.yaml +++ b/src/common/navigation.yaml @@ -35,13 +35,17 @@ sections: - path: /storage-write-read - path: /collections - path: /collection-type - - path: /data-indexing - pages: - - path: /overview - - path: /integrate - - path: /models - - path: /collaborate - - path: /server-extras + sections: + - title: Data Indexing + usePageTitles: true + pages: + - path: /indexing-overview + - path: /indexing-models + - path: /indexing-collaborate + - path: /indexing-server-extras + - title: Tutorials + pages: + - path: /integrate-indexing - path: /stacks-blockchain pages: - path: /overview diff --git a/src/pages/build-an-app.md b/src/pages/build-an-app.md index 23f2ba4e..c12e5c90 100644 --- a/src/pages/build-an-app.md +++ b/src/pages/build-an-app.md @@ -17,7 +17,7 @@ Prefer to jump right in? Get started with this tutorial where you’ll create a Decentralized apps are apps that don’t depend on a centralized platform, server or database. Instead, they use a decentralized network, built on the Stacks blockchain, for [authentication](/authentication/overview), [data storage](/data-storage/overview), -and [backend logic](/data-indexing/overview). Just like Bitcoin, a decentralized network of applications is accessible to +and [backend logic](/data-storage/indexing-overview). Just like Bitcoin, a decentralized network of applications is accessible to anyone and not controlled by any central authority. To learn more about the Blockstack network and decentralization, read the [Blockstack overview](/ecosystem/overview). @@ -41,7 +41,7 @@ other apps without requiring permission or fear of being shut out. ## Getting started To build your decentralized app, you’ll use [authentication](/authentication/overview), [data storage](/data-storage/overview), -[data indexing](/data-indexing/overview) (optional), and [smart contracts](/smart-contracts/overview) (optional). +[data indexing](/data-storage/indexing-overview) (optional), and [smart contracts](/smart-contracts/overview) (optional). Get started with the documentation and tutorials below. ### Authentication and data storage @@ -64,7 +64,7 @@ If you need to store and index data shared by multiple users, such as messages o documentation. [@page-reference | inline] -| /data-indexing/overview +| /data-storage/indexing-overview ### Smart contracts diff --git a/src/pages/data-indexing/collaborate.md b/src/pages/data-storage/indexing-collaborate.md similarity index 100% rename from src/pages/data-indexing/collaborate.md rename to src/pages/data-storage/indexing-collaborate.md diff --git a/src/pages/data-indexing/models.md b/src/pages/data-storage/indexing-models.md similarity index 100% rename from src/pages/data-indexing/models.md rename to src/pages/data-storage/indexing-models.md diff --git a/src/pages/data-indexing/overview.md b/src/pages/data-storage/indexing-overview.md similarity index 96% rename from src/pages/data-indexing/overview.md rename to src/pages/data-storage/indexing-overview.md index d130b021..2edb60b8 100644 --- a/src/pages/data-indexing/overview.md +++ b/src/pages/data-storage/indexing-overview.md @@ -1,5 +1,5 @@ --- -title: Radiks +title: Indexing overview description: Using Radiks you can build multi-player apps that index, store, and query user data. images: large: /images/pages/radiks.svg @@ -17,6 +17,11 @@ multi-player DApps that: - display real-time updates that reflect in progress changes - support collaboration among sets of users +Want to jump right in and start integrating indexing into your app? Try this tutorial: + +[@page-reference | inline] +| /data-storage/integrate-indexing + ## Why use Radiks? Many applications serve data that users create to share publicly with others. Facebook, Twitter, and Instagram are diff --git a/src/pages/data-indexing/server-extras.md b/src/pages/data-storage/indexing-server-extras.md similarity index 99% rename from src/pages/data-indexing/server-extras.md rename to src/pages/data-storage/indexing-server-extras.md index 537ddde0..27db339c 100644 --- a/src/pages/data-indexing/server-extras.md +++ b/src/pages/data-storage/indexing-server-extras.md @@ -1,5 +1,5 @@ --- -title: Radiks server tips and tricks +title: Server tips and tricks description: Some tips and tricks for working with a Radiks server. --- diff --git a/src/pages/data-indexing/integrate.md b/src/pages/data-storage/integrate-indexing.md similarity index 97% rename from src/pages/data-indexing/integrate.md rename to src/pages/data-storage/integrate-indexing.md index 59c47b26..27624d46 100644 --- a/src/pages/data-indexing/integrate.md +++ b/src/pages/data-storage/integrate-indexing.md @@ -1,6 +1,14 @@ --- title: Integrate Radiks -description: Learn how to setup Radiks with your application. +description: Learn how to setup Radiks with your application +icon: BlockstackIcon +duration: 1 hour +experience: intermediate +tags: + - tutorial +images: + large: /images/pages/radiks.svg + sm: /images/pages/radiks-sm.svg --- ## Introduction