fleet/website
Eric 2d0f33f369
Website: Add script for creating HTML email partials from Markdown articles (#7574)
* add to-html-email

* email-preview

* add build-html-email script, update .gitignore

* email preview and email-templates pages, update routes, importer and policies

* add newsletter email layout, build-html-email script, to-html-email updates

* Update .gitignore

* add newsletter emails section to growth handbook

* update scripts

* update fonts in emails

* Update README.md

* Update build-html-email.js

* update comments, add page scripts to layouts

* revert change to build-static-content

* update script

* update email layout and helper

* update handbook entry

* update template data and helper

* update email layout

* update fake data and unsubscribe link

* move added handbook section to the marketing handbook

* rename script

* update colors in unused email template

* update capitalization in helper

* view-email-preview » view-email-template-preview

* Hide emails generated from markdown if they don't exist

* update preview page

* update markdown email directory, create sample article email

* lint fixes, add target="_blank" to links in emails

* update page layouts & styles

* update sample newsletter email, code font, newsletter layout

* Update README.md

* Update view-email-template-preview.js

Co-authored-by: Tim Kern <tim@fleetdm.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-12-05 16:30:24 -06:00
..
api Website: Add script for creating HTML email partials from Markdown articles (#7574) 2022-12-05 16:30:24 -06:00
assets Website: Add script for creating HTML email partials from Markdown articles (#7574) 2022-12-05 16:30:24 -06:00
config Website: Add script for creating HTML email partials from Markdown articles (#7574) 2022-12-05 16:30:24 -06:00
scripts Website: Add script for creating HTML email partials from Markdown articles (#7574) 2022-12-05 16:30:24 -06:00
tasks Move fleetdm.com into main Fleet repo (#83) 2020-12-02 14:48:03 -06:00
views Website: Add script for creating HTML email partials from Markdown articles (#7574) 2022-12-05 16:30:24 -06:00
.editorconfig Move fleetdm.com into main Fleet repo (#83) 2020-12-02 14:48:03 -06:00
.eslintignore Website: Add storybook to Fleet website (#8203) 2022-10-28 19:48:14 -05:00
.eslintrc Website: Add Newsletter banner and NewsletterSubscription model (#7370) 2022-09-02 17:38:34 -05:00
.gitignore fix gitignore 2021-05-11 16:01:25 -05:00
.htmlhintrc Move fleetdm.com into main Fleet repo (#83) 2020-12-02 14:48:03 -06:00
.lesshintrc Move fleetdm.com into main Fleet repo (#83) 2020-12-02 14:48:03 -06:00
.npmrc Move fleetdm.com into main Fleet repo (#83) 2020-12-02 14:48:03 -06:00
.sailsrc Website: Disable freeze/refreeze logic + gut sailsrc (#5547) 2022-05-03 17:59:10 -05:00
app.js Move fleetdm.com into main Fleet repo (#83) 2020-12-02 14:48:03 -06:00
Gruntfile.js Move fleetdm.com into main Fleet repo (#83) 2020-12-02 14:48:03 -06:00
package.json upgrade @sailshq/connect-redis to 6.1.3 (#7842) 2022-09-19 18:00:05 -05:00
Procfile Dedupe setting of env var (#87) 2020-12-03 16:11:46 -06:00
README.md Website README: Add instructions for db migrations (#7161) 2022-08-10 23:23:13 -05:00

fleetdm.com

This is where the code for the public https://fleetdm.com website lives.

Bugs

To report a bug or make a suggestion for the website, click here.

Testing locally

Run the following commands to test the site locally:

npm install -g sails
cd website/
npm install
sails run scripts/build-static-content.js
sails lift

Your local copy of the website is now running at http://localhost:2024!

Deploying the website

To deploy changes to the website to production, merge changes to the main branch. If the changes affect the website's code, or touch any files that the website relies on to build content, such as the query library, osquery schema, docs, handbook, articles, etc., then the website will be redeployed.

Wondering how this works? This is implemented in a GitHub action in this repo. Check out the code there to see how it works! For help understanding what sails run and npm run commands in there do, check the scripts in website/package.json and in website/scripts/.

Changing the database schema

To deploy new code to production that relies on changes to the database schema or other external systems (e.g. Stripe), first put the website in "maintenance mode" in Heroku. Then, make your changes in the database schema. Next, if you have a script to fix/migrate existing data, go ahead and run it now. (e.g. sails run fix-or-migrate-existing-data). Then, merge your changes and wait for the deploy to finish. Finally, switch off "maintenance mode" in Heroku.

Note that entering maintenance mode prevents visitors from using the website, so it should be used sparingly, and ideally at low-traffic times of day.

Warning: Doing an especially sensitive schema migration? There is a potential timing issue to consider, thanks to an infrastructure change that eliminated downtime during deploys by using Heroku's built-in support for hot-swapping. Read more in https://github.com/fleetdm/fleet/issues/6568#issuecomment-1211503881

Wiping the production database

I hope you know what you're doing. The "easiest" kind of database schema migration:

sails_datastores__default__url='REAL_DB_URI_HERE' sails run wipe

Then when you see the sailboat, hit CTRL+C to exit. All done!