diff --git a/docs/Gemfile b/docs/Gemfile index ec69e38..784f227 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -8,8 +8,9 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } # If you have any plugins, put them here! group :jekyll_plugins do - gem 'just-the-docs' # XXX Our Jekyll theme - See https://pmarsceill.github.io/just-the-docs/ - gem "github-pages" # XXX Necessary to reproduce the behaviour of GitHub Pages - When this is loaded, "jekyll" must not be bundled because it's included within + gem 'just-the-docs' # XXX Our Jekyll theme - See https://pmarsceill.github.io/just-the-docs/ + gem "github-pages" # XXX Necessary to reproduce the behaviour of GitHub Pages - When this is loaded, "jekyll" must not be bundled because it's included within + gem 'jemoji' # XXX GitHub-flavored Emoji plugin for Jekyll - See https://github.com/jekyll/jemoji end # ------- WINDOWS SUPPORT --------- diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 821428b..97ae322 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -251,6 +251,7 @@ PLATFORMS DEPENDENCIES github-pages + jemoji just-the-docs tzinfo (~> 1.2) tzinfo-data diff --git a/docs/_config-development.yml b/docs/_config-development.yml index 772d222..8d16e59 100644 --- a/docs/_config-development.yml +++ b/docs/_config-development.yml @@ -33,6 +33,7 @@ footer_content: "Copyright © 2020 Unly. **Tip**: You can start the project in **debug mode** (built-in for WebStorm only) [by running the WebStorm "Debug" configuration in debug mode](https://youtu.be/3vbkiRAT4e8) +> +> **Tip**: Configure your IDE not to index `.next` and `.now` folders as they will eat a lot of your memory because they're changed very frequently +> On WebStorm, right click on the folders and select `Mark directory as > Excluded`. diff --git a/docs/_includes/vendors/vendor-row-amplitude.md b/docs/_includes/vendors/vendor-row-amplitude.md new file mode 100644 index 0000000..80ecd07 --- /dev/null +++ b/docs/_includes/vendors/vendor-row-amplitude.md @@ -0,0 +1 @@ +| [Amplitude](https://amplitude.com/pricing?ref=unly-nrn) | :white_check_mark: | :white_check_mark: [1st year free](https://amplitude.com/startups?ref=unly-nrn) _(for startups and non-profit)_ | Don't provide discounts | diff --git a/docs/_includes/vendors/vendor-row-graphcms.md b/docs/_includes/vendors/vendor-row-graphcms.md new file mode 100644 index 0000000..eed2372 --- /dev/null +++ b/docs/_includes/vendors/vendor-row-graphcms.md @@ -0,0 +1 @@ +| [GraphCMS](https://graphcms.com/pricing?ref=unly-nrn) | :white_check_mark: | :white_check_mark: **Growth** plan 2 weeks | Provide discounts for non-profit organisations | diff --git a/docs/_includes/vendors/vendor-row-locize.md b/docs/_includes/vendors/vendor-row-locize.md new file mode 100644 index 0000000..5b989d2 --- /dev/null +++ b/docs/_includes/vendors/vendor-row-locize.md @@ -0,0 +1 @@ +| [Locize](https://locize.com/pricing.html?ref=unly-nrn) | :x: | :white_check_mark: 2 weeks | May provide discount for non-profit organisations, contact them at [support@locize.com](support@locize.com ) | diff --git a/docs/_includes/vendors/vendor-row-sentry.md b/docs/_includes/vendors/vendor-row-sentry.md new file mode 100644 index 0000000..d295690 --- /dev/null +++ b/docs/_includes/vendors/vendor-row-sentry.md @@ -0,0 +1 @@ +| [Sentry](https://sentry.io/pricing?ref=unly-nrn) | :white_check_mark: | :white_check_mark: Any plan 2 weeks | Don't provide discounts | diff --git a/docs/_includes/vendors/vendor-row-zeit.md b/docs/_includes/vendors/vendor-row-zeit.md new file mode 100644 index 0000000..e711b4d --- /dev/null +++ b/docs/_includes/vendors/vendor-row-zeit.md @@ -0,0 +1 @@ +| [Zeit](https://zeit.co/pricing?ref=unly-nrn) | :white_check_mark: | :x: (but free plan is better than trial) | Friendly pricing for [non-commercial usage](https://spectrum.chat/zeit/general/deploying-on-ziet-now~700e3286-551f-42d1-a289-df4cb52e23ea?m=MTU4MzgzMjg1MzAyOA==) | diff --git a/docs/_includes/vendors/vendor-table.md b/docs/_includes/vendors/vendor-table.md new file mode 100644 index 0000000..e4e559f --- /dev/null +++ b/docs/_includes/vendors/vendor-table.md @@ -0,0 +1,7 @@ +{% if variant %} +The following vendors are **built-in** with the variant `{{variant}}`. +{% endif %} + +| Vendor | Has free plan | Has free trial | Potential discounts | +|:-------------|:------------------|:------|:----| +{% if include.zeit == true%}{% include vendors/vendor-row-zeit.md %}{% endif %}{% if include.graphcms == true%}{% include vendors/vendor-row-graphcms.md %}{% endif %}{% if include.locize == true%}{% include vendors/vendor-row-locize.md %}{% endif %}{% if include.amplitude == true%}{% include vendors/vendor-row-amplitude.md %}{% endif %}{% if include.sentry == true%}{% include vendors/vendor-row-sentry.md %}{% endif %} diff --git a/docs/_includes/zeit-online-deployment-full.md b/docs/_includes/zeit-online-deployment-full.md new file mode 100644 index 0000000..bbc4d49 --- /dev/null +++ b/docs/_includes/zeit-online-deployment-full.md @@ -0,0 +1,15 @@ +1. (Optional) Run `now login` if you aren't authenticated to Zeit from your local machine. Typically, if it's the first time you use Zeit you'll need to do it. +1. You need to change the associated Zeit `scope` (it currently uses the boilerplate's, because it's required for our CI/CD Github Actions) + - Remove the whole line `"scope": "team_qnVfSEVc2WwmOE1OYhZr4VST",` in all `now.*.json` files + - `yarn start` - Will create a `.now` folder containing project metadata. + - Add a `scope` line in all `now.*.json` files using the `projectId` in `.now/project.json` +1. Create all [Zeit secrets](https://zeit.co/docs/v2/environment-variables-and-secrets) by running `now secrets add $secretName $secretValue`, for instance `now secrets add nrn-sentry-dsn https://14fa1cae05079675b18cd05403ae5c48@sentry.io/1234567`. + The full list of expected Zeit secrets to define is in any `now.*.json` file. +1. `yarn deploy` - Will deploy the project online, and automatically create the Zeit project first, if it doesn't exist already. + This command will fail if any secret is missing. +1. Go to [Zeit](https://zeit.co/) to see the project being deployed, go through logs, etc. + +At this point, manual deploy through command line should work. +But CI/CD requires [additional configuration](../guides/ci-cd/setup-github-actions) to automatically deploy when a change is applied on the remote repository. + +{% include zeit-online-deployment-tips.md %} diff --git a/docs/_includes/zeit-online-deployment-tips.md b/docs/_includes/zeit-online-deployment-tips.md new file mode 100644 index 0000000..95af6a1 --- /dev/null +++ b/docs/_includes/zeit-online-deployment-tips.md @@ -0,0 +1,5 @@ +> Zeit doesn't provide the `projectId` from the Zeit platform itself, even if the project exists already. Running `yarn start` locally is the only way to know what is your `projectId`, AFAIK. +> +> If you create a secret with a wrong value, you will have to delete it and create it again (there is no update feature). See `now secrets --help` +> +> **Tip**: If you ever need to store files as secrets (such as ssh keys), see [this solution](https://github.com/zeit/now/issues/749#issuecomment-533873759) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 348ee38..10f4c40 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -87,6 +87,7 @@

Table of contents

{% endif %} {% unless page.comments == false %} +