diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index 3a1b56921e..2d7fedb313 100644 --- a/.github/workflows/docs-deploy.yml +++ b/.github/workflows/docs-deploy.yml @@ -7,19 +7,23 @@ on: # Only run action if changes have been made # to the documentation or components packages paths: - - "packages/documentation/**" - - "packages/components/**" + - 'packages/documentation/**' + - 'packages/components/**' + - '.github/workflows/docs-deploy.yml' jobs: build_and_deploy: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: '18.13.0' - name: Get yarn cache directory path id: yarn-cache-dir-path - run: echo "::set-output name=dir::$(yarn config get cacheFolder)" + run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT # Setup yarn 2 cache: https://github.com/actions/cache/blob/main/examples.md#node---yarn - name: Setup Cache - uses: actions/cache@v2 + uses: actions/cache@v3 id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) with: path: ${{ steps.yarn-cache-dir-path.outputs.dir }} diff --git a/packages/documentation/data-migration.md b/packages/documentation/data-migration.md deleted file mode 100644 index 21744a3b2c..0000000000 --- a/packages/documentation/data-migration.md +++ /dev/null @@ -1,12 +0,0 @@ -# Data Migration - -The platform consists of many interacting components, including local cache and server databases, frontend code, backend code and serverless functions, and cloud file storage. - -From time to time (such as ahead of large updates), it might be useful to migrate all data to a In order to fully ensure major updates aren't breaking, a full preview deployment is a useful way to check for legacy or unexpected issues. - -Currently this can be done in a semi-automated way using a script in the scripts folder, however this requires the user to have various software packages installed on their computer as well as access to any/all projects used. - -``` -cd scripts -ts-node ./maintenance/firebase-project-migrate.ts -``` diff --git a/packages/documentation/docusaurus.config.gh-pages.js b/packages/documentation/docusaurus.config.gh-pages.js index c24e01dc09..1ec935c20e 100644 --- a/packages/documentation/docusaurus.config.gh-pages.js +++ b/packages/documentation/docusaurus.config.gh-pages.js @@ -1,7 +1,7 @@ module.exports = { title: 'OneArmy Community Platform', tagline: 'Developer Documentation', - url: 'https://onearmy.github.io/community-platform', + url: 'https://onearmy.github.io', baseUrl: '/community-platform/', onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', @@ -73,7 +73,7 @@ module.exports = { routeBasePath: '/', // Please change this to your repo. editUrl: - 'https://github.com/ONEARMY/community-platform/edit/master/documentation', + 'https://github.com/ONEARMY/community-platform/edit/master/packages/documentation', }, // blog: { // showReadingTime: true, diff --git a/packages/documentation/docusaurus.config.js b/packages/documentation/docusaurus.config.js index 5fcc14285e..482d477633 100644 --- a/packages/documentation/docusaurus.config.js +++ b/packages/documentation/docusaurus.config.js @@ -75,12 +75,6 @@ module.exports = { editUrl: 'https://github.com/ONEARMY/community-platform/edit/master/packages/documentation', }, - // blog: { - // showReadingTime: true, - // // Please change this to your repo. - // editUrl: - // 'https://github.com/facebook/docusaurus/edit/master/website/blog/', - // }, theme: { customCss: require.resolve('./src/css/custom.css'), }, diff --git a/packages/documentation/firestore-backup.md b/packages/documentation/firestore-backup.md deleted file mode 100644 index c0c835a46e..0000000000 --- a/packages/documentation/firestore-backup.md +++ /dev/null @@ -1,59 +0,0 @@ -## Backup - -In order to fully backup the platform there are 3 areas that need to be backed up: - -1. Firestore Database - https://console.cloud.google.com/firestore/import-export?project=onearmyworld - - Use in interactive export tool to create a backup of the database. If planning to analyse in bigquery then individual collections should be specified, otherwise exporting the entire database would be recommended - ![](images/firestore-backup-1.png) - - The backup can be made to the existing `onearmyworld-exports` bucket, or a personal storage bucket. Exports should be named in a consistent way: - - The backup can also be downloaded using the [gsutil](https://cloud.google.com/storage/docs/gsutil) tool - - ``` - gsutil cp -r gs://onearmyworld-exports/name-of-backup ./my-local-backup-folder - ``` - -2. Firebase Storage - This is a bucket in firebase cloud storage, and so can be handled in a similar way to the firestore database, via the gcloud console - - ![](images/firestore-backup-2.png) - - Additionally, files can be downloaded to backup locally or to another storage provider via [gsutil](https://cloud.google.com/storage/docs/gsutil) run from a local command line, e.g. - - ``` - gsutil cp -r \ - gs://onearmyworld.appspot.com/uploads \ - ./my-local-backup-folder - ``` - -3. Firebase Auth Users - See documentation: https://firebase.google.com/docs/cli/auth - -## Migrate/Clone - -``` - -``` - -## Service worker - -- activate required api: https://console.cloud.google.com/apis/api/cloudresourcemanager.googleapis.com -- creating -- permissions (easiest to assign as viewer for source, and datastore import/export target) - - Source firestore - viewer - - Target firestore - viewer, datastore import/export - - Storage bucket - storage admin -- https://cloud.google.com/firestore/docs/security/iam#roles -- https://cloud.google.com/iam/docs/granting-changing-revoking-access -- - Check - -``` -gcloud projects list -``` - -``` -gcloud auth list -``` diff --git a/packages/documentation/src/pages/example.index.js b/packages/documentation/src/pages/example.index.js deleted file mode 100644 index a25aaa0910..0000000000 --- a/packages/documentation/src/pages/example.index.js +++ /dev/null @@ -1,99 +0,0 @@ -import React from 'react' -import clsx from 'clsx' -import Layout from '@theme/Layout' -import Link from '@docusaurus/Link' -import useDocusaurusContext from '@docusaurus/useDocusaurusContext' -import useBaseUrl from '@docusaurus/useBaseUrl' -import styles from './styles.module.css' - -const features = [ - { - title: 'Easy to Use', - imageUrl: 'img/undraw_docusaurus_mountain.svg', - description: ( - <> - Docusaurus was designed from the ground up to be easily installed and - used to get your website up and running quickly. - - ), - }, - { - title: 'Focus on What Matters', - imageUrl: 'img/undraw_docusaurus_tree.svg', - description: ( - <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go - ahead and move your docs into the docs directory. - - ), - }, - { - title: 'Powered by React', - imageUrl: 'img/undraw_docusaurus_react.svg', - description: ( - <> - Extend or customize your website layout by reusing React. Docusaurus can - be extended while reusing the same header and footer. - - ), - }, -] - -function Feature({ imageUrl, title, description }) { - const imgUrl = useBaseUrl(imageUrl) - return ( -
- {imgUrl && ( -
- {title} -
- )} -

{title}

-

{description}

-
- ) -} - -function Home() { - const context = useDocusaurusContext() - const { siteConfig = {} } = context - return ( - -
-
-

{siteConfig.title}

-

{siteConfig.tagline}

-
- - Get Started - -
-
-
-
- {features && features.length > 0 && ( -
-
-
- {features.map((props, idx) => ( - - ))} -
-
-
- )} -
-
- ) -} - -export default Home diff --git a/packages/documentation/src/pages/styles.module.css b/packages/documentation/src/pages/styles.module.css deleted file mode 100644 index c1aa85121c..0000000000 --- a/packages/documentation/src/pages/styles.module.css +++ /dev/null @@ -1,37 +0,0 @@ -/* stylelint-disable docusaurus/copyright-header */ - -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 4rem 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 966px) { - .heroBanner { - padding: 2rem; - } -} - -.buttons { - display: flex; - align-items: center; - justify-content: center; -} - -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureImage { - height: 200px; - width: 200px; -}