From cbd29f73c03d6d5637cfbdcc2e0ad9a4bacde072 Mon Sep 17 00:00:00 2001 From: Luke Watts Date: Sat, 7 May 2022 22:17:54 +0200 Subject: [PATCH] chore: extend accepted words and address spelling mistakes --- .cspell.json | 19 ++++++++++++------- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- BOUNTIES.md | 2 +- CODE_OF_CONDUCT.md | 14 +++++++------- CONTRIBUTING.md | 8 ++++---- README.md | 4 ++-- packages/components/README.md | 2 +- packages/components/tsconfig.json | 2 +- packages/cypress/src/support/index.ts | 2 +- packages/documentation/data-migration.md | 4 ++-- .../firebase-emulators-docker.md | 2 +- .../Backend Development/firebase-emulators.md | 10 +++++++--- .../docs/Backend Development/integrations.md | 2 +- .../docs/Backend Development/overview.md | 2 +- .../docs/Contributing/bounties.md | 2 +- .../docs/Contributing/maintainer.md | 2 +- .../docs/Deployment/circle-ci.md | 4 ++-- .../docs/Docs Contribution/md-style-guide.md | 4 ++-- packages/documentation/docs/Examples/mdx.md | 2 +- .../docs/Frontend Development/modules.md | 4 ++-- .../docs/Frontend Development/overview.md | 6 +++--- .../docs/Server Maintenance/data-migration.md | 2 +- .../docs/Server Maintenance/manual-backups.md | 2 +- .../documentation/docs/Testing/end-to-end.md | 2 +- packages/documentation/firestore-backup.md | 2 +- packages/emulators-docker/README.md | 6 +++--- .../Notifications/notifications.service.ts | 2 +- src/themes/fonts/README.md | 8 ++++++++ 28 files changed, 71 insertions(+), 54 deletions(-) diff --git a/.cspell.json b/.cspell.json index 80433a364..637acd2d8 100644 --- a/.cspell.json +++ b/.cspell.json @@ -1,14 +1,18 @@ { "version": "0.2", - "language": "en", + "language": "en-GB", "ignorePaths": ["node_modules/**", "**/node_modules/**"], "words": [ "appengine", "appspot", + "bigquery", + "blockquotes", + "boxen", "circleci", "dockerhub", + "dockerised", "dockerode", - "ENOENT", + "enoent", "firebase", "firestore", "formattedly", @@ -18,14 +22,15 @@ "howto", "howtos", "indexeddb", - "Kamp", + "kamp", "mappins", "mattia", + "microservices", "onearmyworld", - "Phonebloks", + "phonebloks", + "redownload", "runtimeconfig", - "taskkill", - "truetype", - "Varela" + "strikethrough", + "taskkill" ] } diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 6986fa32e..92b4ee6c4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,14 +10,14 @@ assignees: '' A clear and concise description of what the bug is. **To Reproduce** -Steps to reproduce the behavior: +Steps to reproduce the behaviour: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +**Expected behaviour** A clear and concise description of what you expected to happen. **Screenshots** diff --git a/BOUNTIES.md b/BOUNTIES.md index 11a0999c7..79b4cc8f5 100644 --- a/BOUNTIES.md +++ b/BOUNTIES.md @@ -65,4 +65,4 @@ These roles include tasks like: - Documentation - Issue management -There is a separate hourly payscale for these roles, aimed at developers who help a bit more consistently at around 2-3h per week. If you're interested in these roles then feel free to reach out on slack or during the monthly dev call. +There is a separate hourly pay scale for these roles, aimed at developers who help a bit more consistently at around 2-3h per week. If you're interested in these roles then feel free to reach out on slack or during the monthly dev call. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 252c0d790..56a543720 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,12 +6,12 @@ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal +level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards -Examples of behavior that contributes to creating a positive environment +Examples of behaviour that contributes to creating a positive environment include: - Using welcoming and inclusive language @@ -20,7 +20,7 @@ include: - Focusing on what is best for the community - Showing empathy towards other community members -Examples of unacceptable behavior by participants include: +Examples of unacceptable behaviour by participants include: - The use of sexualized language or imagery and unwelcome sexual attention or advances @@ -34,13 +34,13 @@ Examples of unacceptable behavior by participants include: ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. +behaviour and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behaviour. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, +permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful. ## Scope @@ -54,7 +54,7 @@ further defined and clarified by project maintainers. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be +Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at [platform@onearmy.earth](mailto:platform@onearmy.earth?subject=contact%20from%20github%20conduct). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c9f23227..40e1bb68c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ If you think something is missing, consider sending us a PR. ## 👐   Code of Conduct -This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [platform@onearmy.earth](mailto:platform@onearmy.earth). +This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [platform@onearmy.earth](mailto:platform@onearmy.earth). ## 🤖   Technologies @@ -75,14 +75,14 @@ Some issues are collated to form modules which are the parent of each section of Additionally if you have identified a bug you may want to write a test to make reproducible (and less likely to arise in the future). You can find more information to do this in the [Testing Bugs Wiki](https://github.com/ONEARMY/community-platform/wiki/Testing---Bugs) -We've also labeled some of the issues with _Good-first-issue_ to help you get started quickly. +We've also labelled some of the issues with _Good-first-issue_ to help you get started quickly. When you start working on an issue, comment on it or if your are a registered contributor assign yourself to let us know so we avoid working on something twice. The comment should include a mention to @mattia-io (our project lead). When a group of issues have been resolved a pull request to the `master` branch should be made, where it will undergo a quick review and test. It is expected that the developer will have done thorough testing themselves first, this helps make sure most pull requests get merged quickly. ## 🤑   Development Bounties -We have a small bounty system as a way of saying thanks to developers for contributiong their time and code. Find out more about it in [Bounties](./BOUNTIES.md) +We have a small bounty system as a way of saying thanks to developers for contributing their time and code. Find out more about it in [Bounties](./BOUNTIES.md) ## 🏠   Project Structure @@ -114,7 +114,7 @@ We use additional branches to define a specific feature or issue group being wor ## 🚀   Deployment -The `master` branch is our current development leading branch, and will autodeploy to the +The `master` branch is our current development leading branch, and will auto-deploy to the [development site](https://dev.onearmy.world/). The `production` branch deploys to the live [community platform site](http://community.preciousplastic.com/) ## 🤓   Javascript style guide diff --git a/README.md b/README.md index 8114b995e..7a8371ed3 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,11 @@ For the past 5+ years we’ve worked together with thousands of people from all - A project's success is closely linked to its community, and for a new project starting up, finding and creating their own strong community is often a time-consuming activity that can take lots of resources. - While working on a project we often find ourselves having to use a multitude of digital tools that are often incomplete, disconnected, privately owned and not open source. -This platform aims to tackle these problems by creating a strong unified community for the different projects under its umbrella and offering the necessary tools to collaborate and connect in one single place. Free and opensource. +This platform aims to tackle these problems by creating a strong unified community for the different projects under its umbrella and offering the necessary tools to collaborate and connect in one single place. Free and open-source. ## ⚡️   What is this platform? -Our community platform helps people to grow communites and make it easier to collaborate on environmental projects in one single place. A place where people can meet, help each other, ask and answer questions, share their innovative ways of fixing problems, discover people around them, connect locally, find events and more. It aims to provide the tools to connect both online and offline. Amongst other features we have How-to, Events and Maps. +Our community platform helps people to grow communities and make it easier to collaborate on environmental projects in one single place. A place where people can meet, help each other, ask and answer questions, share their innovative ways of fixing problems, discover people around them, connect locally, find events and more. It aims to provide the tools to connect both online and offline. Amongst other features we have How-to, Events and Maps. ### Have a look on our [website](https://platform.onearmy.earth) to have a clear overview diff --git a/packages/components/README.md b/packages/components/README.md index 1421cd1e7..569085a49 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -4,7 +4,7 @@ These components provide a collection of elements that can be reused across the Components can be combined to help anyone building on the platform to efficiently design consistent experiences for site visitors. -The aim of packaging these components seperately is to: +The aim of packaging these components separately is to: 1. Reduce the overhead for contributors looking to work **only** on the component layer without needing to spin up the entire application locally. 2. Encourage decoupling of presentation layer from business logic, typically stored within the `*.stores.tsx` files. diff --git a/packages/components/tsconfig.json b/packages/components/tsconfig.json index aee0e8949..f28c91738 100644 --- a/packages/components/tsconfig.json +++ b/packages/components/tsconfig.json @@ -51,7 +51,7 @@ // "removeComments": true, /* Disable emitting comments. */ // "noEmit": true, /* Disable emitting files from a compilation. */ // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ - // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behaviour for imports that are only used for types */ // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ diff --git a/packages/cypress/src/support/index.ts b/packages/cypress/src/support/index.ts index 838245ffe..26c6880b3 100644 --- a/packages/cypress/src/support/index.ts +++ b/packages/cypress/src/support/index.ts @@ -3,7 +3,7 @@ // loaded automatically before your test files. // // This is a great place to put global configuration and -// behavior that modifies Cypress. +// behaviour that modifies Cypress. // // You can change the location of this file or turn off // automatically serving support files with the diff --git a/packages/documentation/data-migration.md b/packages/documentation/data-migration.md index 1104fc00c..21744a3b2 100644 --- a/packages/documentation/data-migration.md +++ b/packages/documentation/data-migration.md @@ -2,9 +2,9 @@ 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 unexepected issues. +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 softwares installed on their computer as well as access to any/all projects used. +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 diff --git a/packages/documentation/docs/Backend Development/firebase-emulators-docker.md b/packages/documentation/docs/Backend Development/firebase-emulators-docker.md index 0c4f1850f..daa80ceb1 100644 --- a/packages/documentation/docs/Backend Development/firebase-emulators-docker.md +++ b/packages/documentation/docs/Backend Development/firebase-emulators-docker.md @@ -40,7 +40,7 @@ The emulator should start at http://localhost:4001. Follow the link to see an ov Clicking on individual tabs will take you to a page similar to the firebase console, from where you can interact with services. -Note - any data populated into the emulator will be deleted after the emulator has closed (restoring to original state). See the section below about persistant and seed data +Note - any data populated into the emulator will be deleted after the emulator has closed (restoring to original state). See the section below about persistent and seed data ## Resetting seed data diff --git a/packages/documentation/docs/Backend Development/firebase-emulators.md b/packages/documentation/docs/Backend Development/firebase-emulators.md index 240872d63..7bb4cf200 100644 --- a/packages/documentation/docs/Backend Development/firebase-emulators.md +++ b/packages/documentation/docs/Backend Development/firebase-emulators.md @@ -36,7 +36,7 @@ The emulator should start at http://localhost:4001. Follow the link to see an ov Clicking on individual tabs will take you to a page similar to the firebase console, from where you can interact with services. -Note - any data populated into the emulator will be deleted after the emulator has closed (restoring to original state). See the section below about persistant and seed data +Note - any data populated into the emulator will be deleted after the emulator has closed (restoring to original state). See the section below about persistent and seed data # Seed data @@ -78,7 +78,7 @@ When the emulators close they discard any changes made, so seed data documents t Whilst this is useful to preserve a clean testing state, sometimes it might be desirable to persist changes (such as adding additional auth users, or specific example docs) -This can be achieved by passing the `--export-on-exit=./path/to/export/folder` flag to the script that starts the functions emulators. This can be run by modifiying the functions start at [functions/scripts/start.ts](https://github.com/ONEARMY/community-platform/tree/master/functions/scripts/start.ts) +This can be achieved by passing the `--export-on-exit=./path/to/export/folder` flag to the script that starts the functions emulators. This can be run by modifying the functions start at [functions/scripts/start.ts](https://github.com/ONEARMY/community-platform/tree/master/functions/scripts/start.ts) ```js // change this value if also wanting to export data @@ -134,6 +134,8 @@ Try to identify what is already running, and if required kill the process. Metho _Windows: List processes on port 4003_ + + ```c netstat -ano | findstr 4003 @@ -141,6 +143,8 @@ netstat -ano | findstr 4003 TCP 127.0.0.1:4003 0.0.0.0:0 LISTENING 8272 ``` + + _Windows: Kill process_ ```c @@ -189,4 +193,4 @@ In this example it is trying to locate the seed data which does not exist, so to yarn workspace functions run emulator:seed ``` -There might be similar issues logged in [firesbase-debug.log](https://github.com/ONEARMY/community-platform/tree/master/functions/firebase-debug.log), however this file might be deleted on exit so will require opening before crash +There might be similar issues logged in [firebase-debug.log](https://github.com/ONEARMY/community-platform/tree/master/functions/firebase-debug.log), however this file might be deleted on exit so will require opening before crash diff --git a/packages/documentation/docs/Backend Development/integrations.md b/packages/documentation/docs/Backend Development/integrations.md index a2579871e..2162e4145 100644 --- a/packages/documentation/docs/Backend Development/integrations.md +++ b/packages/documentation/docs/Backend Development/integrations.md @@ -15,4 +15,4 @@ The full code can be seen at [`functions\src\Integrations\firebase-slack.ts`](ht ## Configuration -Sometimes specific urls/api_keys need to be stored to use with the service. This is best done using config variables so that they are not exposed publically, such as those described at [`functions/src/config/config.ts`](https://github.com/ONEARMY/community-platform/blob/master/functions/src/config/config.ts). +Sometimes specific urls/api_keys need to be stored to use with the service. This is best done using config variables so that they are not exposed publicly, such as those described at [`functions/src/config/config.ts`](https://github.com/ONEARMY/community-platform/blob/master/functions/src/config/config.ts). diff --git a/packages/documentation/docs/Backend Development/overview.md b/packages/documentation/docs/Backend Development/overview.md index 5667840e0..1f8dd22f6 100644 --- a/packages/documentation/docs/Backend Development/overview.md +++ b/packages/documentation/docs/Backend Development/overview.md @@ -5,6 +5,6 @@ title: Overview We're currently using cloud functions as part of the existing firebase ecosystem to handle server-side functions. These exist in the functions folder of the repo and have examples of how to trigger from api, cron or direct call. -We have discussed the likes of serverless and aws lambda and are open to using other platforms for microservices, however we are unlikely to do so until we have more stability within the core platform (unless an immediate blockage becomes apparent within the existing tech stack). When designing for backend, devs should try to keep a microservices architecture in mind and write code that could function in multiple environments (i.e. separate out core and platform logic, keep well documented etc.) +We have discussed the likes of serverless and aws lambda and are open to using other platforms for microservices, however we are unlikely to do so until we have more stability within the core platform (unless an immediate blockage becomes apparent within the existing tech stack). When designing for backend, developers should try to keep a microservices architecture in mind and write code that could function in multiple environments (i.e. separate out core and platform logic, keep well documented etc.) So far all of the functions have been written in a node environment, we are not opposed to other languages (and many in the community have experience of python, php etc.) however additional considerations will need to be given for the best way to support the required servers. diff --git a/packages/documentation/docs/Contributing/bounties.md b/packages/documentation/docs/Contributing/bounties.md index c1b167f1b..736ceb82e 100644 --- a/packages/documentation/docs/Contributing/bounties.md +++ b/packages/documentation/docs/Contributing/bounties.md @@ -70,4 +70,4 @@ These roles include tasks like: - Documentation - Issue management -There is a separate hourly payscale for these roles, aimed at developers who help a bit more consistently at around 2-3h per week. If you're interested in these roles then feel free to reach out on slack or during the monthly dev call. +There is a separate hourly pay scale for these roles, aimed at developers who help a bit more consistently at around 2-3h per week. If you're interested in these roles then feel free to reach out on slack or during the monthly dev call. diff --git a/packages/documentation/docs/Contributing/maintainer.md b/packages/documentation/docs/Contributing/maintainer.md index 5cb2c29d2..6c7eeee2f 100644 --- a/packages/documentation/docs/Contributing/maintainer.md +++ b/packages/documentation/docs/Contributing/maintainer.md @@ -15,4 +15,4 @@ These roles include tasks like: - Documentation - Issue management -There is a separate hourly payscale for these roles, aimed at developers who help a bit more consistently at around 2-3h per week. If you're interested in these roles then feel free to reach out on slack or during the monthly dev call. +There is a separate hourly pay scale for these roles, aimed at developers who help a bit more consistently at around 2-3h per week. If you're interested in these roles then feel free to reach out on slack or during the monthly dev call. diff --git a/packages/documentation/docs/Deployment/circle-ci.md b/packages/documentation/docs/Deployment/circle-ci.md index ff07a84b3..3d96ced4c 100644 --- a/packages/documentation/docs/Deployment/circle-ci.md +++ b/packages/documentation/docs/Deployment/circle-ci.md @@ -15,7 +15,7 @@ and storing the credentials as an environment variable (see this [Github Issue]( GOOGLE_APPLICATION_CREDENTIALS_JSON ``` -If using multiple projects (e.g. staging/prodcution) these can be configured in different contexts. +If using multiple projects (e.g. staging/production) these can be configured in different contexts. When configuring a service account the following permissions should be assigned: @@ -32,7 +32,7 @@ however this is less preferable as the token would provide access to all a user' ### Slack Notifications -Send slack notificatons on deploy success/fail/approval-hold: +Send slack notifications on deploy success/fail/approval-hold: ``` SLACK_DEFAULT_CHANNEL diff --git a/packages/documentation/docs/Docs Contribution/md-style-guide.md b/packages/documentation/docs/Docs Contribution/md-style-guide.md index 76c0bd0e3..77886edb8 100644 --- a/packages/documentation/docs/Docs Contribution/md-style-guide.md +++ b/packages/documentation/docs/Docs Contribution/md-style-guide.md @@ -5,7 +5,7 @@ title: Markdown Style Guide # Markdown Style Guide -You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/). +You can write content using [GitHub flavoured Markdown syntax](https://github.github.com/gfm/). ## Markdown Syntax @@ -126,7 +126,7 @@ Colons can be used to align columns. | Tables | Are | Cool | | ------------- | :-----------: | -----: | | col 3 is | right-aligned | \$1600 | -| col 2 is | centered | \$12 | +| col 2 is | centred | \$12 | | zebra stripes | are neat | \$1 | There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. diff --git a/packages/documentation/docs/Examples/mdx.md b/packages/documentation/docs/Examples/mdx.md index f0210fb70..4416668c2 100644 --- a/packages/documentation/docs/Examples/mdx.md +++ b/packages/documentation/docs/Examples/mdx.md @@ -12,6 +12,6 @@ export const Highlight = ({children, color}) => ( {children} ); -Docusaurus green and Facebook blue are my favorite colors. +Docusaurus green and Facebook blue are my favourite colors. I can write **Markdown** alongside my _JSX_! diff --git a/packages/documentation/docs/Frontend Development/modules.md b/packages/documentation/docs/Frontend Development/modules.md index 31cabdda1..367eb399a 100644 --- a/packages/documentation/docs/Frontend Development/modules.md +++ b/packages/documentation/docs/Frontend Development/modules.md @@ -5,7 +5,7 @@ title: Modules The platform consists of multiple _modules_ which provide the building blocks for app features and core functionality. Examples include _howtos_, _events_ and _research_. These modules are designed to be drop-in/drop-out to allow for different combinations of modules to included in specific deployments. -A module can consist of any combination of frontend pages, components, stores, as well as backend db endpoints, methods and triggers. They can import code from shared components folders, common stores and providers (e.g. user, database), but should avoid importing code directly from other modules; if code from another standalone module is required, it is better to try and refactor to a shared reuseable component instead. +A module can consist of any combination of frontend pages, components, stores, as well as backend db endpoints, methods and triggers. They can import code from shared components folders, common stores and providers (e.g. user, database), but should avoid importing code directly from other modules; if code from another standalone module is required, it is better to try and refactor to a shared reusable component instead. ## Integrated Module Folder Structure @@ -26,7 +26,7 @@ modules ## Adding Routes -If the module contains routable pages they should be defined in a single routes file, and where possible use lazy loading to define any child routes +If the module contains pages which require a route they should be defined in a single routes file, and where possible use lazy loading to define any child routes. _myModule.routes.tsx_ diff --git a/packages/documentation/docs/Frontend Development/overview.md b/packages/documentation/docs/Frontend Development/overview.md index b9abe4167..603a59c58 100644 --- a/packages/documentation/docs/Frontend Development/overview.md +++ b/packages/documentation/docs/Frontend Development/overview.md @@ -18,7 +18,7 @@ The main style variables are described in the [theme file](https://github.com/On ## Components -You can find all the basic stateless components in `src/components` and some more complex & statefull components in `src/pages/common`. +You can find all the basic stateless components in `src/components` and some more complex & stateful components in `src/pages/common`. ### Containers @@ -54,7 +54,7 @@ You can add an icon to the button by using the `icon` props : Path : `src/components/Icons` -We use [react-icons](https://react-icons.netlify.com/#/) lightweight library to provide icons. We may need a custom implementation in the futur but for now it's enough. +We use [react-icons](https://react-icons.netlify.com/#/) lightweight library to provide icons. We may need a custom implementation in the future but for now it's enough. How to use : ```js @@ -71,7 +71,7 @@ import { MdFileDownload } from 'react-icons/md' ``` - Add a case for the imported icon to the `Glyph` const. - Then you'll be able to use the new icon anywere in the project by importing the `Icons` component and use it as described above. + Then you'll be able to use the new icon anywhere in the project by importing the `Icons` component and use it as described above. ## Inconsistencies diff --git a/packages/documentation/docs/Server Maintenance/data-migration.md b/packages/documentation/docs/Server Maintenance/data-migration.md index ffb833128..8bf166dea 100644 --- a/packages/documentation/docs/Server Maintenance/data-migration.md +++ b/packages/documentation/docs/Server Maintenance/data-migration.md @@ -5,7 +5,7 @@ title: Automated Backup and 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 unexepected issues. +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 to take a copy of the production site database and copy it to a preview site. diff --git a/packages/documentation/docs/Server Maintenance/manual-backups.md b/packages/documentation/docs/Server Maintenance/manual-backups.md index 5ec5acde0..ecfad2e2c 100644 --- a/packages/documentation/docs/Server Maintenance/manual-backups.md +++ b/packages/documentation/docs/Server Maintenance/manual-backups.md @@ -33,7 +33,7 @@ In order to fully backup the platform there are 3 areas that need to be backed u ./my-local-backup-folder ``` -3. Firbase Auth Users +3. Firebase Auth Users See documentation: https://firebase.google.com/docs/cli/auth ## Importing Data from a Backup diff --git a/packages/documentation/docs/Testing/end-to-end.md b/packages/documentation/docs/Testing/end-to-end.md index f6bae3dfd..3798904b9 100644 --- a/packages/documentation/docs/Testing/end-to-end.md +++ b/packages/documentation/docs/Testing/end-to-end.md @@ -33,7 +33,7 @@ When testing is initiated a random prefix is generated to uniquely seed/clear th Currently testing is carried out against chrome(stable) and firefox(latest) browsers. We are not able to support any additional browsers (e.g. safari) via ci as they are not currently supported by cypress. If this changes in the future then it would be good to add. See discussion around this here: https://github.com/ONEARMY/community-platform/issues/611 -### DB Teardown +### Database tear down In case of test fail, documents will not be deleted from the server. This is not a major issue as they all are randomly prefixed, and will just sit in the database. From time-to-time admins may decide to delete any hanging data via the firebase cli. diff --git a/packages/documentation/firestore-backup.md b/packages/documentation/firestore-backup.md index 886c0bc8d..c0c835a46 100644 --- a/packages/documentation/firestore-backup.md +++ b/packages/documentation/firestore-backup.md @@ -29,7 +29,7 @@ In order to fully backup the platform there are 3 areas that need to be backed u ./my-local-backup-folder ``` -3. Firbase Auth Users +3. Firebase Auth Users See documentation: https://firebase.google.com/docs/cli/auth ## Migrate/Clone diff --git a/packages/emulators-docker/README.md b/packages/emulators-docker/README.md index b546429f2..3ffaded82 100644 --- a/packages/emulators-docker/README.md +++ b/packages/emulators-docker/README.md @@ -1,4 +1,4 @@ -## Quickstart +## Quick start See [documentation](../../packages/documentation/docs/Backend%20Development/firebase-emulators-docker.md) @@ -18,7 +18,7 @@ By providing a docker image we can address all issues above and provide better p ## TODO [?] - Support live-reload for functions (linux) -[ ] - Optimise image size (reduce RUN cmds, possible multi-stage build) +[ ] - Optimise image size (reduce RUN commands, possible multi-stage build) [ ] - Remove all legacy functions code [ ] - Add tests to ensure data is exported as expected (e.g all collections exist) [ ] - Consider binding functions src folder and not dist (will require configuring yarn workspaces to populate shared as required, known issue below) @@ -47,7 +47,7 @@ By providing a docker image we can address all issues above and provide better p - Firebase realtime database emulator does not work. All other emulators support providing a `0.0.0.0` host binding to access the docker host, however the realtime database emulator does not appear to be working when set. Requires further investigation, possibly linked to https://github.com/firebase/firebase-tools/issues/2633 -- Boxen, globby and log-update packages have been pinned to older versions as newer require es module imports, which is not currently supported by dockerode (https://github.com/apocas/dockerode/issues/632) +- [Boxen](https://www.npmjs.com/package/boxen), globby and log-update packages have been pinned to older versions as newer require es module imports, which is not currently supported by dockerode (https://github.com/apocas/dockerode/issues/632) ## Links diff --git a/src/stores/Notifications/notifications.service.ts b/src/stores/Notifications/notifications.service.ts index 9d6cf459d..f161adf40 100644 --- a/src/stores/Notifications/notifications.service.ts +++ b/src/stores/Notifications/notifications.service.ts @@ -2,7 +2,7 @@ Sometimes it may be useful to pass information between unrelated components (e.g. side-wide notice, confirmation of event etc.) These could be handled via other mobx stores and creating subscription objects - (e.g. rxjs behaviorSubjects), however additional, simple methods are given here + (e.g. rxjs behaviourSubjects), however additional, simple methods are given here to allow for pubsub exchanges wihtout use of mobx. We keep all the methods here to make it easier to see what topics are in use */ diff --git a/src/themes/fonts/README.md b/src/themes/fonts/README.md index d6d500d1f..5ef07031d 100644 --- a/src/themes/fonts/README.md +++ b/src/themes/fonts/README.md @@ -10,6 +10,8 @@ Note - as the platform relies on modern browser feature legacy font formats (ttf Legacy (css) implementation: Define a `fonts.css` file + + ``` @font-face { font-family: 'Varela Round'; @@ -42,8 +44,12 @@ Define a `fonts.css` file ``` + + Import in `index.html` (note, seemed to break with lazy-loading) + + ``` ``` + +