From 4adb0cb6ed365c59db29d192949e2827dd292f19 Mon Sep 17 00:00:00 2001 From: Kelvin Fichter Date: Thu, 15 Aug 2024 14:24:11 -0400 Subject: [PATCH] fix: links to old docs --- README.md | 6 +++--- pages/404.mdx | 2 +- pages/500.mdx | 2 +- pages/contribute/contribution-path/technerds.mdx | 2 +- patches/remark-lint-frontmatter-schema@3.15.4.patch | 2 +- public/service-worker.js | 4 ++++ theme.config.tsx | 6 +++--- utils/plugins/remark/remark-lint-no-blocked-characters.mjs | 2 +- 8 files changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 62aeb0d12..1f9231abb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Optimism Docs +# Optimism Community Hub -This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo. +This repo houses the Optimism Community Hub located at [community.optimism.io](https://community.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo. ## Local Development @@ -16,7 +16,7 @@ Please see the [CONTRIBUTING.md](CONTRIBUTING.md) page for specifics on how to w ## Project Board -You can track documentation [issues](https://github.com/ethereum-optimism/docs/issues) or submit documentation [requests](https://github.com/ethereum-optimism/docs/issues/new/choose) directly from this repo. +You can track documentation [issues](https://github.com/ethereum-optimism/community-hub/issues) or submit documentation [requests](https://github.com/ethereum-optimism/community-hub/issues/new/choose) directly from this repo. ## License diff --git a/pages/404.mdx b/pages/404.mdx index ee0616b0c..253fb1b5f 100644 --- a/pages/404.mdx +++ b/pages/404.mdx @@ -10,5 +10,5 @@ description: 404 page not found and directs users to submit an git issue. ## Let's find our way back.
Visit the [homepage](index) to get started. -#### Please help by [submitting an issue](https://github.com/ethereum-optimism/docs/issues/new/choose) for the broken link. ❤️ +#### Please help by [submitting an issue](https://github.com/ethereum-optimism/community-hub/issues/new/choose) for the broken link. ❤️ diff --git a/pages/500.mdx b/pages/500.mdx index f2645cf32..e6405f78b 100644 --- a/pages/500.mdx +++ b/pages/500.mdx @@ -10,4 +10,4 @@ description: 500 internal server error and directs users to submit an git issue. ## Something isn't quite right. Let's start again on the [homepage](index). -#### Please help by [submitting an issue](https://github.com/ethereum-optimism/docs/issues/new/choose) about what led you to this page. ❤️ +#### Please help by [submitting an issue](https://github.com/ethereum-optimism/community-hub/issues/new/choose) about what led you to this page. ❤️ diff --git a/pages/contribute/contribution-path/technerds.mdx b/pages/contribute/contribution-path/technerds.mdx index e20d17fc1..324f4fd47 100644 --- a/pages/contribute/contribution-path/technerds.mdx +++ b/pages/contribute/contribution-path/technerds.mdx @@ -23,7 +23,7 @@ You can also see the [Slides for the TechNERD](https://docs.google.com/presentat | Lesson | Topic | Exercise | Link | |:-------|:------|:---------|:-----| | 1 | Getting an RPC Endpoint | Get an RPC endpoint. You will need this for all following exercises. | [Provider Options](https://docs.optimism.io/builders/tools/connect/rpc-providers) | -| 2 | Run an OP Goerli Node | Most developer questions we get are about running a node. Pay special attention to any issues you face or confusion you have. This can take up to 2 weeks (depending on your internet speed) to sync. | [Run a Node](https://community.optimism.io/docs/developers/build/run-a-node/) | +| 2 | Run an OP Goerli Node | Most developer questions we get are about running a node. Pay special attention to any issues you face or confusion you have. This can take up to 2 weeks (depending on your internet speed) to sync. | [Run a Node](https://docs.optimism.io/builders/node-operators/rollup-node) | | 3 | Setting up an OP Stack | The OP Stack is an incredible step towards the Superchain vision. As such you should be familiar with the standard OP Stack. | [Getting Started with the OP Stack](https://docs.optimism.io/stack/getting-started) | 4 | Setting up an explorer for your OP Stack | Make your OP Stack feel more real with its own block explorer! | [Blockscout explorer guide](https://docs.optimism.io/builders/chain-operators/tools/explorer) | 5 | Deploy & bridge a standard ERC20 | As an L2, bridging is a pretty important concept. Make sure you are comfortable with the bridging process. | [Standard Bridge, Standard Token](https://github.com/ethereum-optimism/optimism-tutorial/tree/main/standard-bridge-standard-token) | diff --git a/patches/remark-lint-frontmatter-schema@3.15.4.patch b/patches/remark-lint-frontmatter-schema@3.15.4.patch index 249d94409..8e97429f9 100644 --- a/patches/remark-lint-frontmatter-schema@3.15.4.patch +++ b/patches/remark-lint-frontmatter-schema@3.15.4.patch @@ -7,7 +7,7 @@ index 602dc3851aa1c8499a8c5ae2d810d5e4ee8e87a9..5dd03a2ea17272b8779341ecfd73e2df if (frontmatter?.type === 'yaml') { await validateFrontmatter(frontmatter, vFile, settings); + } else { -+ // Specific logic for the ethereum-optimism/docs repository. We ++ // Specific logic for the ethereum-optimism/community-hub repository. We + // always want to have a frontmatter section. Working on getting + // this fixed in the upstream plugin so we don't need this hack. + throw new Error('Missing frontmatter') diff --git a/public/service-worker.js b/public/service-worker.js index 6725c200e..d00e03df6 100644 --- a/public/service-worker.js +++ b/public/service-worker.js @@ -1,3 +1,7 @@ +// Script exists to clear the service worker cache from the old website. Please keep this script +// around until we're confident that users have the latest version of the site. Since Next doesn't +// use service workers it should be safe to keep this around indefinitely if needed. + self.addEventListener('install', (event) => { // Force the service worker to take control immediately self.skipWaiting() diff --git a/theme.config.tsx b/theme.config.tsx index 554df46dc..6d521dd05 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -16,9 +16,9 @@ const config: DocsThemeConfig = { ), darkMode: true, project: { - link: 'https://github.com/ethereum-optimism/docs', + link: 'https://github.com/ethereum-optimism/community-hub', }, - docsRepositoryBase: 'https://github.com/ethereum-optimism/docs/blob/main/', + docsRepositoryBase: 'https://github.com/ethereum-optimism/community-hub/blob/main/', footer: { text: 'OP Documentation', }, @@ -66,7 +66,7 @@ const config: DocsThemeConfig = { const { asPath, defaultLocale, locale } = useRouter() const { frontMatter } = useConfig() const url = - 'https://docs.optimism.io' + + 'https://community.optimism.io' + (defaultLocale === locale ? asPath : `/${locale}${asPath}`) return ( diff --git a/utils/plugins/remark/remark-lint-no-blocked-characters.mjs b/utils/plugins/remark/remark-lint-no-blocked-characters.mjs index 027635f28..877e9d648 100644 --- a/utils/plugins/remark/remark-lint-no-blocked-characters.mjs +++ b/utils/plugins/remark/remark-lint-no-blocked-characters.mjs @@ -9,7 +9,7 @@ import { lintRule } from 'unified-lint-rule' */ const remarkLintNoBlockedCharacters = lintRule( { - url: 'https://github.com/ethereum-optimism/docs', + url: 'https://github.com/ethereum-optimism/community-hub', origin: 'remark-lint:no-blocked-characters' }, (tree, file) => {