Skip to content

Commit

Permalink
first pass preparing for public launch
Browse files Browse the repository at this point in the history
  • Loading branch information
dghelm committed Oct 16, 2024
1 parent 48573f9 commit e9bceed
Show file tree
Hide file tree
Showing 15 changed files with 250 additions and 625 deletions.
12 changes: 5 additions & 7 deletions public/locales/en/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -117,32 +117,27 @@
"scrollArchitecture": "Scroll Architecture",
"scrollUpgrades": "Scroll Upgrades",
"overview": "Overview",

"scrollChain": "Scroll Chain",
"accountsAndState": "Accounts and State",
"blocks": "Blocks",
"transactions": "Transactions",
"rollupProcess": "Rollup Process",
"evmDifferencesFromEthereum": "EVM Differences from Ethereum",

"bridge": "Bridge",
"crossDomainMessaging": "Cross-Domain Messaging",
"depositGateways": "Deposit Gateways",
"withdrawGateways": "Withdraw Gateways",

"sequencer": "Sequencer",
"executionNode": "Execution Node",
"rollupNode": "Rollup Node",
"zkTrie": "zkTrie",

"zkevm": "zkEVM",
"introToZkevm": "Intro to zkEVM",
"zkevmOverview": "zkEVM Overview",
"bridgeOverview": "Bridge Overview",
"prover": "Prover",
"proofGeneration": "Proof Generation",
"cpuProverRepo": "CPU Prover Repo",

"security": "Security",
"auditsAndBugBounty": "Audits & Bug Bounty",
"l2BeatAssessment": "L2Beat Assessment"
Expand All @@ -160,18 +155,21 @@
"sdk": {
"overview": "Overview",
"scrollSdk": "Scroll SDK Introduction",
"earlyAccessProgram": "Early Access Program",
"faq": "Scroll SDK FAQ",
"technicalStack": "Technical Stack",
"stackOverview": "Stack Overview",
"configuration": "Configuration",
"services": "Services",
"smartContracts": "Smart Contracts",
"proofGeneration": "Proof Generation",
"integrations": "Integrations",
"guides": "Guides",
"runOnArm64Mac": "Run on ARM64 Mac",
"devnetDeployment": "Devnet Deployment",
"productionDeployment": "Production Deployment",
"digitalOcean": "Digital Ocean & ERC20 Gas Token Testnet"
"digitalOcean": "Digital Ocean & ERC20 Gas Token Testnet",
"aws": "AWS Deployment",
"customizingSdkComponents": "Customizing SDK Components"
}
},
"footer": {
Expand Down
20 changes: 14 additions & 6 deletions src/config/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -345,8 +345,8 @@ export const getSidebar = () => {
url: "sdk/",
},
{
title: t("sidebar.sdk.earlyAccessProgram"),
url: "sdk/early-access-program",
title: t("sidebar.sdk.faq"),
url: "sdk/sdk-faq",
},
],
},
Expand All @@ -373,6 +373,10 @@ export const getSidebar = () => {
title: t("sidebar.sdk.proofGeneration"),
url: formatUrl("sdk/technical-stack/proof-generation"),
},
{
title: t("sidebar.sdk.integrations"),
url: formatUrl("sdk/technical-stack/integrations"),
},
],
},
{
Expand All @@ -390,10 +394,14 @@ export const getSidebar = () => {
title: t("sidebar.sdk.digitalOcean"),
url: formatUrl("sdk/guides/digital-ocean-alt-gas-token"),
},
// {
// title: t("sidebar.sdk.runOnArm64Mac"),
// url: formatUrl("sdk/guides/run-on-arm64-mac"),
// },
{
title: t("sidebar.sdk.aws"),
url: formatUrl("sdk/guides/aws-deployment"),
},
{
title: t("sidebar.sdk.customizingSdkComponents"),
url: formatUrl("sdk/guides/customizing-sdk-components"),
},
],
},
],
Expand Down
72 changes: 0 additions & 72 deletions src/content/docs/en/sdk/early-access-program.mdx

This file was deleted.

23 changes: 23 additions & 0 deletions src/content/docs/en/sdk/guides/aws-deployment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
section: sdk
date: Last Modified
title: "AWS Deployment"
lang: "en"
permalink: "sdk/guides/aws-deployment"
excerpt: "Get accustomed to the process of running an SDK deployment using AWS."
---

import Aside from "../../../../../components/Aside.astro"
import ToggleElement from "../../../../../components/ToggleElement.astro"
import Steps from '../../../../../components/Steps/Steps.astro';
import ClickToZoom from "../../../../../components/ClickToZoom.astro"

{/* TODO: write this guide */}

This guide documents getting a Scroll SDK deployment working on AWS's EKS and managed databases, using Cloudflare for DNS.

If you haven't already deployed a local Devnet, please try that first.

<Aside type="caution">
Scroll SDK is still in development.
</Aside>
19 changes: 19 additions & 0 deletions src/content/docs/en/sdk/guides/customizing-sdk-components.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
section: sdk
date: Last Modified
title: "Customizing SDK Components"
lang: "en"
permalink: "sdk/guides/customizing-sdk-components"
excerpt: "Learn to make custom changes to Scroll SDK services"
---

import Aside from "../../../../../components/Aside.astro"
import ToggleElement from "../../../../../components/ToggleElement.astro"
import Steps from '../../../../../components/Steps/Steps.astro';
import ClickToZoom from "../../../../../components/ClickToZoom.astro"

{/* TODO: write this guide */}

This guide documents how to run custom components in your own Scroll SDK deployment.

We'll see how to modify a service, build a custom Docker image, and deploy your changes to an existing Scroll SDK deployment.
Original file line number Diff line number Diff line change
Expand Up @@ -536,4 +536,6 @@ To quickly get started with Grafana, run the following command:

Now, visit the localhost URL in [your browser](http://localhost:3000/). The default password for the `admin` user is `prom-operator`.

Adding an ingress URL, changing the default password or adding LDAP login are all suggested if you use this stack in production. */}
Adding an ingress URL, changing the default password or adding LDAP login are all suggested if you use this stack in production. */}

{/* TODO: Add guide for disabling testnet finalization without proofs and add Sindri prover setup. */}
Loading

0 comments on commit e9bceed

Please sign in to comment.