From 4499d7bfa815c33fa5b665221e8a0457fa886ac5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=ADcholas=20Andr=C3=A9?= Date: Fri, 8 Mar 2024 15:35:59 -0300 Subject: [PATCH 1/5] docs: add deploying docs section --- docs/documentation/09-Deploying/data-dog.md | 6 ++++++ .../09-Deploying/gettining-ready.md | 19 +++++++++++++++++++ docs/documentation/09-Deploying/hosting.md | 13 +++++++++++++ 3 files changed, 38 insertions(+) create mode 100644 docs/documentation/09-Deploying/data-dog.md create mode 100644 docs/documentation/09-Deploying/gettining-ready.md create mode 100644 docs/documentation/09-Deploying/hosting.md diff --git a/docs/documentation/09-Deploying/data-dog.md b/docs/documentation/09-Deploying/data-dog.md new file mode 100644 index 000000000..c00099e0b --- /dev/null +++ b/docs/documentation/09-Deploying/data-dog.md @@ -0,0 +1,6 @@ +--- +slug: /deploying/data-dog +sidebar_label: Setting up Data Dog +--- + +# Setting up Data-Dog diff --git a/docs/documentation/09-Deploying/gettining-ready.md b/docs/documentation/09-Deploying/gettining-ready.md new file mode 100644 index 000000000..3437157a5 --- /dev/null +++ b/docs/documentation/09-Deploying/gettining-ready.md @@ -0,0 +1,19 @@ +--- +slug: /deploying +sidebar_label: Getting Ready +sidebar_position: 0 +--- + +# Getting Ready to deploy + +Before deploying we recommend checking out a few things to ensure a smooth launch. Here's a quick checklist: + +- Confirm SEO meta tags are working. HeadstartWP has an out-of-the-box integration with the Yoast SEO plugin. +- Confirm your sitemaps are working. If you have the Yoast SEO plugin, HeadstartWP will proxy sitemaps through WP and ensure links are replaced with the front-end links +- Check out your robots.txt, HeadstarWP will proxy it through WP as well. +- Check out ads.txt, HeadstartWP will also proxy it through WP. We recommend installing the [ads.txt](https://wordpress.org/plugins/ads-txt/) plugin. +- Consider setting up application monitoring such as [DataDog](./data-dog.md), New-Relic or Sentry. + +## Hosting Options + +You can deploy HeadstartWP to any hosting that supports Next.js. Check out our [Hosting Recommendations](./hosting.md) page. \ No newline at end of file diff --git a/docs/documentation/09-Deploying/hosting.md b/docs/documentation/09-Deploying/hosting.md new file mode 100644 index 000000000..4b9a1b7e9 --- /dev/null +++ b/docs/documentation/09-Deploying/hosting.md @@ -0,0 +1,13 @@ +--- +slug: /deploying/hosting +sidebar_label: Hosting +sidebar_position: 1 +--- + +# Hosting Recommendations + +## Vercel + +## WordPress VIP + +## WP Engine Atlas \ No newline at end of file From 5987f7b1cef1eaa87ac737c64008a0973ebb04c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=ADcholas=20Andr=C3=A9?= Date: Fri, 8 Mar 2024 15:44:29 -0300 Subject: [PATCH 2/5] docs: update language --- docs/documentation/09-Deploying/gettining-ready.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/documentation/09-Deploying/gettining-ready.md b/docs/documentation/09-Deploying/gettining-ready.md index 3437157a5..08c1830cc 100644 --- a/docs/documentation/09-Deploying/gettining-ready.md +++ b/docs/documentation/09-Deploying/gettining-ready.md @@ -14,6 +14,6 @@ Before deploying we recommend checking out a few things to ensure a smooth launc - Check out ads.txt, HeadstartWP will also proxy it through WP. We recommend installing the [ads.txt](https://wordpress.org/plugins/ads-txt/) plugin. - Consider setting up application monitoring such as [DataDog](./data-dog.md), New-Relic or Sentry. -## Hosting Options +## Hosting -You can deploy HeadstartWP to any hosting that supports Next.js. Check out our [Hosting Recommendations](./hosting.md) page. \ No newline at end of file +You can deploy HeadstartWP to any hosting that supports Next.js. We've tested HeadstartWP on a few platforms. Check out our [Hosting](./hosting.md) page for some tips. \ No newline at end of file From 6d1b2737a74e2c9d95f727822b20e15140a2eb0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=ADcholas=20Andr=C3=A9?= Date: Fri, 8 Mar 2024 15:49:15 -0300 Subject: [PATCH 3/5] docs: update language --- docs/documentation/09-Deploying/hosting.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/documentation/09-Deploying/hosting.md b/docs/documentation/09-Deploying/hosting.md index 4b9a1b7e9..ece31def9 100644 --- a/docs/documentation/09-Deploying/hosting.md +++ b/docs/documentation/09-Deploying/hosting.md @@ -4,7 +4,9 @@ sidebar_label: Hosting sidebar_position: 1 --- -# Hosting Recommendations +# Hosting + +We've tested HeadstartWP on the following hosting platforms. We've listed here some tips when hosting on these platforms. ## Vercel From d4a8e7dfd0bc92d2ec5a022e57337252c4653f99 Mon Sep 17 00:00:00 2001 From: Dustin Rue Date: Fri, 8 Mar 2024 13:32:28 -0600 Subject: [PATCH 4/5] docs: branding --- docs/documentation/09-Deploying/data-dog.md | 6 ------ docs/documentation/09-Deploying/gettining-ready.md | 4 ++-- 2 files changed, 2 insertions(+), 8 deletions(-) delete mode 100644 docs/documentation/09-Deploying/data-dog.md diff --git a/docs/documentation/09-Deploying/data-dog.md b/docs/documentation/09-Deploying/data-dog.md deleted file mode 100644 index c00099e0b..000000000 --- a/docs/documentation/09-Deploying/data-dog.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -slug: /deploying/data-dog -sidebar_label: Setting up Data Dog ---- - -# Setting up Data-Dog diff --git a/docs/documentation/09-Deploying/gettining-ready.md b/docs/documentation/09-Deploying/gettining-ready.md index 08c1830cc..a7484d00b 100644 --- a/docs/documentation/09-Deploying/gettining-ready.md +++ b/docs/documentation/09-Deploying/gettining-ready.md @@ -12,8 +12,8 @@ Before deploying we recommend checking out a few things to ensure a smooth launc - Confirm your sitemaps are working. If you have the Yoast SEO plugin, HeadstartWP will proxy sitemaps through WP and ensure links are replaced with the front-end links - Check out your robots.txt, HeadstarWP will proxy it through WP as well. - Check out ads.txt, HeadstartWP will also proxy it through WP. We recommend installing the [ads.txt](https://wordpress.org/plugins/ads-txt/) plugin. -- Consider setting up application monitoring such as [DataDog](./data-dog.md), New-Relic or Sentry. +- Consider setting up application monitoring such as [Datadog](./datadog.md), New-Relic or Sentry. ## Hosting -You can deploy HeadstartWP to any hosting that supports Next.js. We've tested HeadstartWP on a few platforms. Check out our [Hosting](./hosting.md) page for some tips. \ No newline at end of file +You can deploy HeadstartWP to any hosting that supports Next.js. We've tested HeadstartWP on a few platforms. Check out our [Hosting](./hosting.md) page for some tips. From 750cb24083949a94ace0a8e9710b54aaa49c5130 Mon Sep 17 00:00:00 2001 From: Dustin Rue Date: Fri, 8 Mar 2024 14:38:53 -0600 Subject: [PATCH 5/5] docs: add information about dd-trace --- docs/documentation/09-Deploying/datadog.md | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/documentation/09-Deploying/datadog.md diff --git a/docs/documentation/09-Deploying/datadog.md b/docs/documentation/09-Deploying/datadog.md new file mode 100644 index 000000000..1357fb4eb --- /dev/null +++ b/docs/documentation/09-Deploying/datadog.md @@ -0,0 +1,36 @@ +--- +slug: /deploying/datadog +sidebar_label: Setting up Datadog +--- + +# Setting up Datadog + +If you have access to Datadog for application monitoring and want to configure your HeadstartWP project to send data to Datadog, then this guide will help you get started. As of this writing, this guide is meant to assist you when running HeadstartWP in your own hosting infrastructure or on a hosting platform that offers Datadog APM. Adding basic Datadog support is extremely simple and only requires a couple of steps. Your hosting platform may have additional requirements so check with them to ensure you have configured everything properly. + +The following steps will help you get Datadog tracing installed and activate: + +### Add dd-trace +You must first add Datadog's dd-trace library to your project. How you do so depends on if you are using workspaces or not. In general, you add the dd-trace library in the usual way with: + +``` +npm install -s dd-trace +``` + +Modify this to add the `--workspace` option if you are using workspaces, adjusting the path to locate your project. The command will look similar to: + +``` +npm install -s --workspace @path/to/workspace dd-trace +``` + +You will find more detailed directions at [https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs/](https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs/) + +### Activate dd-trace +Once dd-trace is added to your project you must activate it in the hosting environment. While you can activate dd-trace in code, you may find it easier to activate using an environment variable passed to the Node process. In addition to the usual set of [environment variables used to configure dd-trace](https://ddtrace.readthedocs.io/en/stable/configuration.html) you can tell the Node process itself to initialize dd-trace using an environment variable. How this variable is set depends on the hosting platform and your preferences. + +The required environment variable to pass to the Node process is: + +``` +NODE_OPTIONS='--require dd-trace/init' +``` + +You can set this however you please but note that you _cannot_ set this using the .env file for your project. This file is loaded too late in the initialization process to take affect.