You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 15, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: guides/caching.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Caching
2
2
3
-
This guide introduces the caching capabilities of the Moovweb XDN
3
+
This guide introduces the caching capabilities of {{ PRODUCT_NAME }}
4
4
5
5
## Environments and Caching
6
6
@@ -281,7 +281,7 @@ The cache will automatically be cleared when you make changes to your router. A
281
281
282
282
## Clearing the Cache
283
283
284
-
The cache is automatically cleared when you deploy to an environment. You can also clear the cache using the environment's Caching tab in the Moovweb XDN console.
284
+
The cache is automatically cleared when you deploy to an environment. You can also clear the cache using the environment's Caching tab in {{ PRODUCT_NAME }} console.
Copy file name to clipboardExpand all lines: guides/contributing.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The XDN is all about putting power in the hands of developers and our documentation is no different. The source code for the XDN developer docs (i.e. this site your reading now) is in an open [repository on Github](https://github.com/moovweb-docs/xdn-docs) and we welcome feedback and pull requests. If you've found a typo or a better way to explain something, please submit a pull request or a file issue! Others will likely stumble over the same problem and benefit from your insight.
4
4
5
-
## Running locally
5
+
## Running locally
6
6
7
7
To run the XDN docs on your machine, first clone the repository locally,
8
8
@@ -27,7 +27,7 @@ Finally, visit the site in your browser at http://127.0.0.1:3000.
27
27
28
28
## Architecture
29
29
30
-
The XDN docs are a simple Next.js application running on the Moovweb XDN (yes we [dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food)). The content is stored as pages called "guides". Each guide is a Markdown file located in the [guides folder](https://github.com/moovweb-docs/xdn-docs/tree/master/guides) and the [guides.json](https://github.com/moovweb-docs/xdn-docs/blob/master/guides/guides.json) controls the navigation menu for reaching the guides.
30
+
The XDN docs are a simple Next.js application running on {{ PRODUCT_NAME }} (yes we [dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food)). The content is stored as pages called "guides". Each guide is a Markdown file located in the [guides folder](https://github.com/moovweb-docs/xdn-docs/tree/master/guides) and the [guides.json](https://github.com/moovweb-docs/xdn-docs/blob/master/guides/guides.json) controls the navigation menu for reaching the guides.
31
31
32
32
## How to contribute
33
33
@@ -42,4 +42,3 @@ We recommend the following process for submitting a change:
42
42
5. Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) back to the XDN Docs repository via Github web interface.
43
43
44
44
For more details, the Pro Git book has a [helpful contributing guide](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) that walks you through the process of submitting a pull request to an open source repository on Github.
Copy file name to clipboardExpand all lines: guides/cookies.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,5 +4,5 @@ This guide covers the cookies that Moovweb XDN creates and uses.
4
4
5
5
## Split testing cookies
6
6
7
-
*`xdn_bucket`: a number between 1 and 100 randomly assigned by the Moovweb XDN to all clients connecting to it. It is a long-lived non-session cookie allowing predictable cohorts during split testing. Its value is not accessible from client-side JavaScript code.
8
-
*`xdn_destination`: the name of the experience to which split testing has assigned the user based on the value of `xdn_bucket`. Its value is accessible to client-side JavaScript code and can thus be safely included in client-side metrics.
7
+
-`xdn_bucket`: a number between 1 and 100 randomly assigned by {{ PRODUCT_NAME }} to all clients connecting to it. It is a long-lived non-session cookie allowing predictable cohorts during split testing. Its value is not accessible from client-side JavaScript code.
8
+
-`xdn_destination`: the name of the experience to which split testing has assigned the user based on the value of `xdn_bucket`. Its value is accessible to client-side JavaScript code and can thus be safely included in client-side metrics.
Copy file name to clipboardExpand all lines: guides/core_web_vitals.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Instead of relying solely on Google Search Console, we recommend tracking Core W
27
27
28
28
## Installation
29
29
30
-
In order to start tracking Core Web Vitals on the Moovweb XDN, you need add the `@xdn/rum` client library to your application. There are a number of ways to do this:
30
+
In order to start tracking Core Web Vitals on {{ PRODUCT_NAME }}, you need add the `@xdn/rum` client library to your application. There are a number of ways to do this:
31
31
32
32
### Script Tag
33
33
@@ -156,19 +156,19 @@ new XDN.Metrics({
156
156
pageLabel:'home',
157
157
158
158
// When running a split test, use this field to specify which variant is active.
159
-
// This is automatically set for sites that are deployed on the Moovweb XDN.
159
+
// This is automatically set for sites that are deployed on {{ PRODUCT_NAME }}.
160
160
splitTestVariant:'name-of-variant',
161
161
162
162
// The version of your application that is running.
163
163
appVersion:'v1.0.0',
164
164
165
165
// Whether or not the page was served from the CDN cache, if this is known.
166
-
// This is automatically set for sites that are deployed on the Moovweb XDN.
166
+
// This is automatically set for sites that are deployed on {{ PRODUCT_NAME }}.
167
167
cacheHit:true|false,
168
168
169
169
// The country code in which the browser is running. This is often provided by CDNs
170
170
// as a request header that can be embedded in your script tab by your application code.
171
-
// This is automatically set for sites that are deployed on the Moovweb XDN.
171
+
// This is automatically set for sites that are deployed on {{ PRODUCT_NAME }}.
Copy file name to clipboardExpand all lines: guides/deploying.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Deploying
2
2
3
-
This guide walks you through deploying your first site to the Moovweb XDN.
3
+
This guide walks you through deploying your first site to {{ PRODUCT_NAME }}.
4
4
5
5
## Create your Account
6
6
7
-
To deploy your site to the Moovweb XDN, you must first sign up for an account. [Sign up here for free.](https://moovweb.app/signup)
7
+
To deploy your site to {{ PRODUCT_NAME }}, you must first sign up for an account. [Sign up here for free.](https://moovweb.app/signup)
8
8
9
9
## Install the XDN CLI
10
10
@@ -22,26 +22,27 @@ yarn global add @xdn/cli
22
22
23
23
## xdn login
24
24
25
-
Run the following to authenticate with your XDN account on the Moovweb XDN:
25
+
Run the following to authenticate with your XDN account on {{ PRODUCT_NAME }}:
26
26
27
27
```bash
28
28
xdn login
29
29
```
30
+
30
31
## xdn deploy
31
32
32
-
Then, run the following to deploy your site to your private space on the Moovweb XDN:
33
+
Then, run the following to deploy your site to your private space on {{ PRODUCT_NAME }}:
33
34
34
35
```bash
35
36
xdn deploy
36
37
```
37
38
38
-
The CLI will automatically detect the framework you're using, create an optimized production build, and upload it to the Moovweb XDN. This takes about a minute for most applications.
39
+
The CLI will automatically detect the framework you're using, create an optimized production build, and upload it to {{ PRODUCT_NAME }}. This takes about a minute for most applications.
39
40
40
41
Once the deployment is complete, the CLI will output the URL for your site. The site name is automatically derived from the `name` field in `package.json`. This can be overriden by using `--site` option when running `xdn deploy`.
41
42
42
43
## Branches and Deployments
43
44
44
-
Each time you deploy your site to the Moovweb XDN a "deployment" is created and given a unique and permanent URL based on the team name, site name, branch name in source control, and an incrementing deployment number. If you use Git, the branch name is set by the default. If not, you can specify the `--branch` option when running `xdn deploy`.
45
+
Each time you deploy your site to {{ PRODUCT_NAME }} a "deployment" is created and given a unique and permanent URL based on the team name, site name, branch name in source control, and an incrementing deployment number. If you use Git, the branch name is set by the default. If not, you can specify the `--branch` option when running `xdn deploy`.
45
46
46
47

47
48
@@ -65,14 +66,14 @@ You should always store your deploy token using your CI environment's secrets ma
Here is an example GitHub action that deploys your site to the Moovweb XDN:
69
+
Here is an example GitHub action that deploys your site to {{ PRODUCT_NAME }}:
69
70
70
71
This action assumes that you have created environments called "staging" and "production" and you have created a deploy key for your site and added it as a secret in your repo called "xdn_deploy_token".
71
72
72
73
```yml
73
74
# Add this file to your project at .github/workflows/xdn.yml
74
75
#
75
-
# This GitHub action deploys your site on the Moovweb XDN.
76
+
# This GitHub action deploys your site on {{ PRODUCT_NAME }}.
76
77
#
77
78
# The site is deployed each time commits are pushed. The environment to which the changes are deployed
78
79
# is based on the following rules:
@@ -135,7 +136,7 @@ jobs:
135
136
136
137
## Jenkins Pipeline
137
138
138
-
Here is an example Jenkins pipeline that deploys your site to the Moovweb XDN:
139
+
Here is an example Jenkins pipeline that deploys your site to {{ PRODUCT_NAME }}:
139
140
140
141
This guide assumes:
141
142
@@ -147,7 +148,7 @@ This guide assumes:
147
148
```groovy
148
149
// Add this file to your project at ./Jenkinsfile
149
150
//
150
-
// This Jenkins pipeline deploys your site on the Moovweb XDN.
151
+
// This Jenkins pipeline deploys your site on {{ PRODUCT_NAME }}.
151
152
//
152
153
// The site is deployed each time commits are pushed. The environment to which the changes are deployed
Copy file name to clipboardExpand all lines: guides/frontity.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Frontity
2
2
3
-
This guide shows you how to deploy [Frontity](https://frontity.org/) apps on the Moovweb XDN
3
+
This guide shows you how to deploy [Frontity](https://frontity.org/) apps on {{ PRODUCT_NAME }}
4
4
5
5
## Example Site
6
6
@@ -25,7 +25,7 @@ If you don't already have a Frontity app, use the terminal (or command prompt on
25
25
npx frontity create my-app
26
26
```
27
27
28
-
To prepare your Frontity app for deployment on the Moovweb XDN, run the following in the root folder of your project:
28
+
To prepare your Frontity app for deployment on {{ PRODUCT_NAME }}, run the following in the root folder of your project:
29
29
30
30
```
31
31
npm install -g @xdn/cli
@@ -34,7 +34,7 @@ xdn init
34
34
35
35
This will automatically add all of the required dependencies and files to your project. These include:
36
36
37
-
- The `@xdn/core` package - Allows you to declare routes and deploy your application on the Moovweb XDN
37
+
- The `@xdn/core` package - Allows you to declare routes and deploy your application on {{ PRODUCT_NAME }}
38
38
- The `@xdn/frontity` package - Provides router middleware that automatically adds Frontity routes to the XDN router.
39
39
- The `@xdn/prefetch` package - Allows you to configure a service worker to prefetch and cache pages to improve browsing speed
40
40
- The `@xdn/react` package - Provides a `Prefetch` component for prefetching pages
@@ -98,7 +98,7 @@ xdn dev --cache
98
98
99
99
## Deploying
100
100
101
-
Deploying requires an account on the Moovweb XDN. [Sign up here for free.](https://moovweb.app/signup) Once you have an account, you can deploy to the Moovweb XDN by running the following in the root folder of your project
101
+
Deploying requires an account on {{ PRODUCT_NAME }}. [Sign up here for free.](https://moovweb.app/signup) Once you have an account, you can deploy to {{ PRODUCT_NAME }} by running the following in the root folder of your project
Deploying requires an account on the Moovweb XDN. [Sign up here for free.](https://moovweb.app/signup) Once you have an account, you can deploy to the Moovweb XDN by running the following in the root folder of your project:
58
+
Deploying requires an account on {{ PRODUCT_NAME }}. [Sign up here for free.](https://moovweb.app/signup) Once you have an account, you can deploy to {{ PRODUCT_NAME }} by running the following in the root folder of your project:
Copy file name to clipboardExpand all lines: guides/isg.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
The Next.js framework first introduced the pattern of Incremental Static (Re)Generation (commonly referred to as **ISG**) to the JAMStack community. With ISG, some URLs are rendered at build time, while others aren't rendered until a user actually visits the page (the app essentially falls back to server-side rendering). A static loading page is returned while server-side rendering is in progress. Individual statically rendered URLs can also be configured to expire after some time (this is the *re*generation part).
4
4
5
-
The Moovweb XDN provides full support for Incremental Static (Re)Generation, not just on apps built with Next.js (where the `@xdn/next` package makes this automatic), but on apps built with any framework.
5
+
{{ PRODUCT_NAME }} provides full support for Incremental Static (Re)Generation, not just on apps built with Next.js (where the `@xdn/next` package makes this automatic), but on apps built with any framework.
6
6
7
7
## Adding ISG to Next.js apps
8
8
9
-
Developers using Next.js don't need to do anything special to support ISG on the Moovweb XDN. Simply use the `NextRoutes` router plugin:
9
+
Developers using Next.js don't need to do anything special to support ISG on {{ PRODUCT_NAME }}. Simply use the `NextRoutes` router plugin:
0 commit comments