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
pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!"
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -14,12 +14,12 @@ Not all pages have a 1-1 mapping with their location within the repository. This
14
14
15
15
## Want to go deeper? Fork the repository
16
16
17
-
You can fork this repository to your local machine to make larger changes. Examples of larger changes include:
17
+
You can fork this repository and clone it to your local machine to make larger changes. Examples of larger changes include:
18
18
- editing more than one file at a time
19
19
- adding or updating images
20
20
- updating navigation items
21
21
22
-
In this scenario, you'll fork the repository locally, make your changes, and submit a pull request to have them reviewed and merged back into the site.
22
+
In this scenario, you'll fork the repository, clone it locally, make your changes, and submit a pull request to have them reviewed and merged back into the site.
Copy file name to clipboardExpand all lines: README.md
+9-3
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,8 @@
3
3
4
4
Here, you can contribute to the Segment Documentation site.
5
5
6
+
**Note**: On Friday, October 1st, the default branch of this repository was changed from `master` to `develop`. If you have a fork of `segment-docs`, please ensure the default branch of the fork is updated accordingly.
7
+
6
8
## Overview
7
9
8
10
This repository contains the documentation website code and source files for https://segment.com/docs.
@@ -16,17 +18,21 @@ In this article, find information about:
16
18
17
19
## Contributing
18
20
19
-
The Segment docs team accepts a few types of contribution, including:
21
+
The Segment docs team accepts contributions in the form of issues and pull requests.
22
+
23
+
All accepted contributions, in the form of approved pull requests and resolved issues, are deployed twice weekly, on Tuesday and Thursdays. As a result, once your pull request is closed, or your issue resolved, you may not see these changes on the site immediately.
20
24
21
25
### Issues
22
26
23
27
If you see an error or something incorrect on a specific page, click Request docs change to create an issue to bring it to the team’s attention.
24
28
25
29
### Pull Requests
26
30
27
-
If you would like to update the documentation yourself, create a Pull Request to bring it to the team’s attention. Click Edit this page to edit the page directly on GitHub. Alternatively, you can clone the repository and submit your Pull Request that way. For more information, see Contributing and the Developer Guide
31
+
If you would like to update the documentation yourself, create a Pull Request to bring it to the team’s attention. Click Edit this page to edit the page directly on GitHub. Alternatively, you can clone the repository and submit your Pull Request that way. For more information, see [Contributing](CONTRIBUTING.md) and the [Developer Guide](devguide.md)
32
+
33
+
34
+
28
35
29
-
For more information about contributing, see [Contributing](CONTRIBUTING.md).
* Ensure you're running `RubyGems` >= 2.5.0 by running `gem update --system` followed by `gem --version`
@@ -16,7 +16,7 @@ If using OSX:
16
16
17
17
## All about the Catalog script
18
18
19
-
You run the Catalog update script by running `make catalog` from the docs repo. You, a person who is going to run the script, must first save a Segment token to an `.env` file locally, which is `gitignored` so we don’t check it in to gihub accidentally.
19
+
You run the Catalog update script by running `make catalog` from the docs repo. You, a person who is going to run the script, must first save a Segment token to an `.env` file locally, which is `gitignored` so we don’t check it in to GitHub accidentally.
20
20
21
21
Note: Old ConfigAPI tokens are not compatible with Public API. You'll need a new one if you want to use Public API.
22
22
@@ -33,7 +33,7 @@ It also does some slugification and destination-name normalization, since our ha
33
33
34
34
### 3.1. <aname='Layouts'></a>Layouts
35
35
36
-
`default.html` is the base container through which all the individual other layouts are built to have the right title, seo, etc. The template inheritance is described in the diagram below.
36
+
`default.html` is the base container through which all the individual other layouts are built to have the right title, SEO, etc. The template inheritance is described in the diagram below.
37
37
38
38
The `destination.html`, `source.html`, and `integration.html` templates contain the logic that runs the layouts for individual catalog pages. Storage/warehouses use the generic Integration right now because they don't need anything special. Set the layout in the Jekyll `_config.yml` file.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/customer-io/index.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th
35
35
analytics.page();
36
36
```
37
37
38
-
Page events send to Customer.io as a `Page View` event where names and properties are optional. In the Customer.io "Activity View", the event will have "Activity Type" set to "Page View" and "Activity Name" set to the page name. If there is no page name, "Activity Name" defaults to the page URL.
38
+
Page events send to Customer.io as a `Page View` event where names and properties are optional. In the Customer.io "Activity Logs", the event will have "Activity Type" set to "Page View" and "Activity Name" set to the page name. If there is no page name, "Activity Name" defaults to the page URL.
39
39
40
40
## Screen
41
41
@@ -45,7 +45,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th
45
45
[[SEGAnalytics sharedAnalytics] screen:@"Home"];
46
46
```
47
47
48
-
Screen events send to Customer.io as a custom event. In the Customer.io "Activity View", "Activity Type" is `event` and "Activity Value" sets to `Viewed {screen name} Screen`. For the earlier example the "Activity Value" will be `Viewed Home Screen`. If there is no screen name, then "Activity Value" will be `Viewed Undefined Screen`.
48
+
Screen events send to Customer.io as a custom event. In the Customer.io "Activity Logs", "Activity Type" is `event` and "Activity Value" sets to `Viewed {screen name} Screen`. For the earlier example the "Activity Value" will be `Viewed Home Screen`. If there is no screen name, then "Activity Value" will be `Viewed Undefined Screen`.
If you want to change the `id` or `email` you've assigned a person in Customer.io, you have to pass a person's `cio_id`, in the format `cio_<cio_id value>` as the `userId` in your identify call. Currently, you must retrieve this value from a person's page in the Customer.io interface. In the future, you'll be able to do that using this call from Customer.io API.
82
+
If you want to change the `id` or `email` you've assigned a person in Customer.io, you have to pass a person's `cio_id`, in the format `cio_<cio_id value>` as the `userId` in your identify call. Currently, you must retrieve this value from a person's page in the Customer.io interface. In the future, you'll be able to do that using this call from Customer.io API.
83
83
84
84
```javascript
85
85
analytics.identify('cio_<cio_id value>', {
@@ -114,7 +114,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th
114
114
analytics.track('Clicked Button');
115
115
```
116
116
117
-
Track events send to Customer.io as `custom events`. In the Customer.io "Activity View", "Activity Type" sets to `event` and "Activity Name" sets to the event name.
117
+
Track events send to Customer.io as `custom events`. In the Customer.io "Activity Logs", "Activity Type" sets to `event` and "Activity Name" sets to the event name.
Copy file name to clipboardExpand all lines: src/personas/debugger.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Using the Personas Source Debugger, you can inspect and monitor the events that
6
6
7
7
Because Personas generates a unique Source for every Destination connected to a Space, the Debugger gives you insight into how Personas sends events before they reach their Destination.
8
8
9
-
The Debugger provides you with the payload information you need to troubleshoot potential formatting issues and ensure process and sends events as your Destinations expect.
9
+
The Debugger provides you with the payload information you need to troubleshoot potential formatting issues and ensure Personas sends events as your Destinations expect.
10
10
11
11
## Working with the Debugger
12
12
@@ -23,4 +23,4 @@ The Debugger displays the payload in two tabs:
23
23
***Pretty view** shows the actual API call Segment sends to your Destination.
24
24
***Raw view** shows the full JSON object Segment sends to your Destination from the calls you sent, including timestamps, properties, traits, and ids.
25
25
26
-
Similar to the Connections Debugger, the Personas Debugger allows you to search through events, using information contained within the event's payload.
26
+
Similar to the Connections Debugger, the Personas Debugger allows you to search through events using information contained within the event's payload.
0 commit comments