Skip to content

Commit fd6698f

Browse files
author
markzegarelli
authored
Merge branch 'master' into thomas/wootric_rebrand_source
2 parents bc549be + 3c6969e commit fd6698f

File tree

8 files changed

+29
-24
lines changed

8 files changed

+29
-24
lines changed

.github/workflows/repo-sync.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
1818
with:
1919
source_repo: ${{ secrets.SOURCE_REPO }}
20-
source_branch: master
20+
source_branch: ${{ secrets.SOURCE_BRANCH }}
2121
destination_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
2222
github_token: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
2323

@@ -27,7 +27,7 @@ jobs:
2727
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
2828
with:
2929
source_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
30-
destination_branch: master
30+
destination_branch: ${{ secrets.DESTINATION_BRANCH }}
3131
pr_title: 'repo sync'
3232
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!"
3333
pr_label: autoupdate,automated-reposync-pr
@@ -39,7 +39,7 @@ jobs:
3939
with:
4040
github-token: ${{ secrets.GITHUB_TOKEN }}
4141
branch: repo-sync
42-
base: master
42+
base: ${{ secrets.DESTINATION_BRANCH }}
4343
author: bot-docsteam
4444
state: open
4545

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Not all pages have a 1-1 mapping with their location within the repository. This
1414

1515
## Want to go deeper? Fork the repository
1616

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:
1818
- editing more than one file at a time
1919
- adding or updating images
2020
- updating navigation items
2121

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.
2323

2424
## Site structure
2525

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
Here, you can contribute to the Segment Documentation site.
55

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+
68
## Overview
79

810
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:
1618

1719
## Contributing
1820

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.
2024

2125
### Issues
2226

2327
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.
2428

2529
### Pull Requests
2630

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+
2835

29-
For more information about contributing, see [Contributing](CONTRIBUTING.md).
3036

3137
## List of READMEs
3238

devguide.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The contents of this guide will help you get up and running with the Segment Doc
44

55
## Local development with `ruby` and `node`, without Config API
66

7-
If using OSX:
7+
If using MacOS:
88
* Install command line tools, `xcode-select --install`
99
* Install `Ruby` >= 2.3.0 https://www.ruby-lang.org/en/documentation/installation/
1010
* Ensure you're running `RubyGems` >= 2.5.0 by running `gem update --system` followed by `gem --version`
@@ -16,7 +16,7 @@ If using OSX:
1616

1717
## All about the Catalog script
1818

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.
2020

2121
Note: Old ConfigAPI tokens are not compatible with Public API. You'll need a new one if you want to use Public API.
2222

@@ -33,7 +33,7 @@ It also does some slugification and destination-name normalization, since our ha
3333

3434
### 3.1. <a name='Layouts'></a>Layouts
3535

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.
3737

3838
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.
3939

src/_includes/content/functions/runtime.md

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ The following dependencies are installed in the function environment by default.
1515
- [`@google-cloud/functions v1.1.0`](https://www.npmjs.com/package/@google-cloud/functions) exposed as `google.cloud.functions`
1616
- [`@google-cloud/pubsub v2.6.0`](https://www.npmjs.com/package/@google-cloud/pubsub) exposed as `google.cloud.pubsub`
1717
- [`@google-cloud/storage v5.3.0`](https://www.npmjs.com/package/@google-cloud/storage) exposed as `google.cloud.storage`
18-
- [`form-data v2.4.0`](https://www.npmjs.com/package/form-data) exposed as `FormData`
1918
- [`jsonwebtoken v8.5.1`](https://www.npmjs.com/package/jsonwebtoken) exposed as `jsonwebtoken`
2019
- [`lodash v4.17.15`](https://www.npmjs.com/package/lodash) exposed as `_`
2120
- [`moment v2.26.0`](https://www.npmjs.com/package/moment/v/2.26.0) exposed as `moment`

src/connections/destinations/catalog/customer-io/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th
3535
analytics.page();
3636
```
3737

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.
3939

4040
## Screen
4141

@@ -45,7 +45,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th
4545
[[SEGAnalytics sharedAnalytics] screen:@"Home"];
4646
```
4747
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`.
4949
5050
5151
## Identify
@@ -79,7 +79,7 @@ analytics.identify('userId123', {
7979
});
8080
```
8181

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_&lt;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.
8383

8484
```javascript
8585
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
114114
analytics.track('Clicked Button');
115115
```
116116

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.
118118

119119
## Device Token Set up
120120

src/personas/audiences/organization.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ To disband a Folder you’ve made in Personas, click the **More Options** icon a
3131

3232
To move an Audience to a Folder you’ve already created, follow the steps below:
3333

34-
1. Navigate to the Audiences tab within your Personas space.
34+
1. Navigate to the **Audiences** tab within your Personas space.
3535
2. Hover over the Audience you want to move.
3636
3. Check the selection box that appears next to the Audience name.
37-
4. **Optional**: repeat Steps 2 and 3 to move multiple Audiences.
37+
4. *(Optional)*: Repeat Steps 2 and 3 to move multiple Audiences.
3838
5. Click the **Move** icon that appears in the Audiences header.
3939
6. Select your destination Folder from the modal window.
4040
7. Click **Move** to confirm and move the selected Audiences.
@@ -48,12 +48,12 @@ Audience cloning creates a copy of your Audience. Within Personas, you can clon
4848

4949
To clone an Audience within the same Space, follow the steps below:
5050

51-
1. Navigate to the Audiences tab within your Personas space.
51+
1. Navigate to the **Audiences** tab within your Personas space.
5252
2. Click the **More Options** icon next to the Audience you want to clone.
5353
3. From the dropdown menu, click **Clone**.
5454
4. Select **Current Space**, then click **Continue**.
5555
5. Configure the Audience, click **Preview Results**, then click **Select Destination**.
56-
6. **Optional**: on the next screen, connect the Audience to a Destination. Click **Review & Create**.
56+
6. *(Optional)*: On the next screen, connect the Audience to a Destination. Click **Review & Create**.
5757
7. Give your Audience a unique name, then click **Create Audience**.
5858

5959
### Cloning an Audience between Spaces
@@ -70,12 +70,12 @@ You may wish to clone an Audience between spaces for a number of use cases, incl
7070
7171
To clone an Audience between Spaces, follow the steps below:
7272

73-
1. Navigate to the Audiences tab within your Personas space.
73+
1. Navigate to the **Audiences** tab within your Personas space.
7474
2. Click the **More Options** icon next to the Audience you want to clone.
7575
3. From the dropdown menu, click **Clone**.
7676
4. Select **Different Space**, choose your target Space, then click **Continue**.
7777
5. Configure the Audience, click **Preview Results**, then click **Select Destination**.
78-
6. **Optional**: on the next screen, connect the Audience to a Destination. Click **Review & Create**.
78+
6. *(Optional)*: On the next screen, connect the Audience to a Destination. Click **Review & Create**.
7979
7. Give your Audience a unique name, then click **Create Cloned Audience**.
8080

8181

src/personas/debugger.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Using the Personas Source Debugger, you can inspect and monitor the events that
66

77
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.
88

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.
1010

1111
## Working with the Debugger
1212

@@ -23,4 +23,4 @@ The Debugger displays the payload in two tabs:
2323
* **Pretty view** shows the actual API call Segment sends to your Destination.
2424
* **Raw view** shows the full JSON object Segment sends to your Destination from the calls you sent, including timestamps, properties, traits, and ids.
2525

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

Comments
 (0)