Skip to content

Commit

Permalink
Release 22.5.1 (segmentio#2443)
Browse files Browse the repository at this point in the history
* Adding admonition infrastructure

* DOC-393 Taking it out of an admonition format and adding it to the paragraph above it

* [DOC-393] Simplifying the information, adding it to the sentence before it

* Fixes to Contributing page

* small update to ga4

* Update CONTRIBUTING.md

Frontmatter -> Front matter

* Add note about Criteo connection modes with Analytics.js (segmentio#2437)

* Add clarity to HubSpot API limit (segmentio#2436)

* Update CONTRIBUTING.md

* catalog update

* Add Troubleshooting section to GEC docs (segmentio#2434)

* add Troubleshooting section to GEC docs

* style edits

Co-authored-by: markzegarelli <[email protected]>

* redirect sprig actions (segmentio#2423)

* remove connection table

* Linking to FQL from Destination Filters doc (segmentio#2421)

* Linking to FQL from Destination Filters doc

* Update src/connections/destinations/destination-filters.md

Co-authored-by: stayseesong <[email protected]>

Co-authored-by: stayseesong <[email protected]>

* [byteplus] adding new destination folder in order to show new name in… (segmentio#2414)

* [byteplus] adding new destination folder in order to show new name in docs URL

* local links should be relative

Co-authored-by: markzegarelli <[email protected]>

* Add region unsupported message for all cloud sources (segmentio#2422)

* Add region unsupported message for all cloud sources

* Remove spaces

* prettify markdown

* copy edits

Co-authored-by: markzegarelli <[email protected]>

Co-authored-by: forstisabella <[email protected]>
Co-authored-by: pwseg <[email protected]>
Co-authored-by: Segment Docs Robot <[email protected]>
Co-authored-by: kdaswani <[email protected]>
Co-authored-by: rchinn-segment <[email protected]>
Co-authored-by: pwseg <[email protected]>
Co-authored-by: Niall Brennan <[email protected]>
Co-authored-by: stayseesong <[email protected]>
Co-authored-by: Thomas Gilbert <[email protected]>
Co-authored-by: jinapark202 <[email protected]>
  • Loading branch information
11 people authored Feb 1, 2022
1 parent bd21e9d commit 275b09f
Show file tree
Hide file tree
Showing 76 changed files with 517 additions and 241 deletions.
4 changes: 0 additions & 4 deletions .vscode/yml.code-snippets
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,4 @@
"body":["- name: ${1:name}\r\tdescription: ${2:description}\r\tdefault: ${3}"],
"description": "Yaml settings"
},
"ext_link":{
"prefix": ["{:}"],
"body":["{:target='${1:_blank}'}"]
},
}
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before you begin:

## Use the contribution links from any docs page

Not all pages have a 1-1 mapping with their location within the repository. This can make browsing and locating the file you're trying to reference a challenge. As you browse [segment.com/docs](https://segment.com/docs), you'll notice two links in the right sidebar, at the top of the page. Click **Edit this page** to open the page in the Github editor. Or, click **Request docs change** to create a new issue that references the page.
Not all pages have a 1-1 mapping with their location within the repository. This can make browsing and locating the file you're trying to reference a challenge. As you browse [segment.com/docs](https://segment.com/docs), you'll notice two links in the right sidebar, at the top of the page. Click **Edit this page** to open the page in the GitHub editor. Or, click **Request docs change** to create a new issue that references the page.

## Want to go deeper? Fork the repository

Expand Down Expand Up @@ -39,7 +39,7 @@ The most interesting ones are:

### Images

**Save all images locally! No linking to 3rd party-hosted images!** Images are published to our CDN from the build step, and this means they won't go missing if the hosting service dujour goes out of business.
**Save all images locally! No linking to third-party hosted images!** Images are published to our CDN from the build step, and this means they won't go missing if the hosting service dujour goes out of business.

There are no _enforced_ naming conventions at this time. Files that start with an underscore are ignored by Jekyll. Anything you see with `asset` was dowloaded by a script to migrate it out of Contents.io.

Expand Down Expand Up @@ -77,11 +77,11 @@ Sources pages check if the source is a cloud-app, then include information about

Content with in each `.md` file is markdown. For information about styling, and available extensions, see `_src/utils/formatguide.md` or the live version [here](https://segment.com/docs/utils/formatguide).

### Frontmatter
### Front matter

Each Markdown file in the docs can have "frontmatter" associated with it at the top of the file. These are considered by Jekyll to be "properties" of a page, generally control how the HTML page is built or rendered.
Repository Markdown files often contain front matter metadata, which you'll find at the top of the file. These front matter variables instruct Jekyll how to build and render the page as HTML.

Frontmatter in a file will look something like this:
Front matter in a file will look something like this:

```md
---
Expand All @@ -90,25 +90,25 @@ hide-feedback: false
---
```

Each piece of frontmatter does something special!
Front matter variables have unique functions, including the following:

#### Content-related frontmatter
#### Content-related front matter
- `beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta-note.md`)
- `rewrite`: defaults to false. This is a legacy frontmatter flag that comes from the old `site-docs` repo, and which labels any destination that was rewritten in ~2018 to a standardized template. It disables the duplicate "connection modes" table that would otherwise show up in the boilerplate content at the end of the page.
- `rewrite`: defaults to false. This is a legacy front matter flag that comes from the old `site-docs` repo, and which labels any destination that was rewritten in ~2018 to a standardized template. It disables the duplicate "connection modes" table that would otherwise show up in the boilerplate content at the end of the page.
- `hide-dossier`: defaults to false. When true, hides the "quick info" box at the top of a destination page.
- `hide-boilerplate`: defaults to false. When true, none of the content from `destination-footer.md` is appended to the destination page.
- `hide-cmodes`: defaults to false. A renaming of "rewrite" for more clarity, hides the connection modes table in the boilerplate.
- `hide-personas-partial`: defaults to false. When true, hides the section of content from `destination-footer.md` that talks about being able to receive personas data.
- `integration_type`: This is set in the `_config.yml` on three paths to add a noun (Source, Destination, or Warehouse) to the end of the title, and the end of the title tag in the html layout. It also controls the layout and icon for some of these.
- `source-type`: These are only used to supplement when a Cloud App in the sources path doesn't appear in the Config API list, and needs its type explicitly set. It runs some logic in the `cloud-app-note.md` to explain which cloud-apps are object vs event sources.

#### Utility frontmatter
#### Utility front matter
- `published`: defaults to true. Set this to "false" to prevent Jekyll from rendering an HTML page for this file. Good for when you're working on something in the repo but aren't ready to release it yet, and don't want to use a Draft PR.
- `hidden`: omits the file from the `sitemap.xml`, adds a `<meta name="robots" content="noindex" />` to the top of the generated HTML file, and drops it from the convenience script for regenerating the nav.
- `hide-sidebar`: defaults to false. When true, hide the entire right-nav sidebar. Use with `hide-feedback` if you want to disable *all* feedback affordances.
- `hide-feedback`: defaults to false. When true, hide the feedback in both rnav and footer. Good for landing pages.
- `hide_toc`: hides the right-nav TOC that's generated from H2s. Also good for landing pages.
- `landing`: defaults to false. Use this to drop the noun set by `integration_type` from the tab title.
- `redirect_from`: Defaults to null. Takes an array of URLs from the frontmatter in a file, and generates a "stub" page at each URL at build-time. Each stub file redirects to the original file. Use the path from the root of the content directory, for example `/connections/destinations/catalog/` rather than `/docs/connections/destinations/catalog/`. **Note** We are mostly using NGINX redirects for SEO purposes. Approximately quarterly, we'll collect these and add them to NGINX.
- `redirect_from`: Defaults to null. Takes an array of URLs from the front matter in a file, and generates a "stub" page at each URL at build-time. Each stub file redirects to the original file. Use the path from the root of the content directory, for example `/connections/destinations/catalog/` rather than `/docs/connections/destinations/catalog/`. **Note** We are mostly using NGINX redirects for SEO purposes. Approximately quarterly, we'll collect these and add them to NGINX.
- `seo-changefreq`: default: `weekly `. Use the values [in the sitemap spec](https://www.sitemaps.org/protocol.html#xmlTagDefinitions). - sets the `changefreq` tag in the sitemap.xml generator, which tells search crawlers how often to check back.
- `seo-priority`: values from `1.0` to `0.1`, default: `0.5 `. Sets the `Priority` tag in the sitemap
20 changes: 13 additions & 7 deletions scripts/catalog_papi.js
Original file line number Diff line number Diff line change
Expand Up @@ -289,13 +289,14 @@ const updateSources = async () => {
}, options);
fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/source_categories.yml`), output);

// Create reginal support map
output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n"
output += "# Last updated " + todayDate + " \n";

// output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n"
// output += "# Last updated " + todayDate + " \n";
output += yaml.dump({
sources: regionalSourcesUpdated
}, options)
fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/regional-supported.yml`), output);
fs.appendFileSync(path.resolve(__dirname, `../src/_data/catalog/regional-supported.yml`), output);
console.log("sources done")
}

const updateDestinations = async () => {
Expand Down Expand Up @@ -482,6 +483,7 @@ const updateDestinations = async () => {
noArrayIndent: false
})
fs.appendFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output);
console.log("destinations done")
}

const updateWarehouses = async () => {
Expand Down Expand Up @@ -545,19 +547,23 @@ const updateWarehouses = async () => {
noArrayIndent: true
};
// output = "# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT\n"
// var todayDate = new Date().toISOString().slice(0, 10);
const todayDate = new Date().toISOString().slice(0, 10);
// output += "# warehouse data last updated " + todayDate + " \n";
// output += yaml.dump({
// items: warehousesUpdated
// }, options);
// fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/warehouse_papi.yml`), output);

output = yaml.dump({
// Create regional support map
output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n"
output += "# Last updated " + todayDate + " \n";
output += yaml.dump({
warehouses: warehousesUpdated
}, {
noArrayIndent: false
})
fs.appendFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output);
fs.writeFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output);
console.log("warehouses done")
}
updateSources()
updateWarehouses()
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/destination_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination categories last updated 2022-01-26
# destination categories last updated 2022-02-01
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
114 changes: 58 additions & 56 deletions src/_data/catalog/destinations.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2022-01-26
# destination data last updated 2022-02-01
items:
- destination_id: 60b5d0a01f3726b85dc05aab
display_name: 2mee
Expand Down Expand Up @@ -28839,6 +28839,63 @@ items:
label: API Key
actions: []
presets: []
- destination_id: 5f2c35239094d175b6485eb1
display_name: Sprig Cloud
name: Sprig Cloud
slug: sprig-cloud
hidden: false
regional:
- us-west
url: connections/destinations/catalog/sprig-cloud
previous_names:
- UserLeap
- Sprig
- Sprig Cloud
website: https://sprig.com
status: PUBLIC
categories:
- Analytics
- Customer Success
- Personalization
- Surveys
logo:
url: >-
https://public-segment-devcenter-production.s3.amazonaws.com/74f53b6f-bc75-4132-b7de-1170cc57202e.svg
mark:
url: >-
https://public-segment-devcenter-production.s3.amazonaws.com/d761456e-2b15-4401-87da-0c3fde847f5b.svg
methods:
track: true
identify: true
group: false
alias: true
page: true
platforms:
browser: true
mobile: true
server: true
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
replay: false
connection_modes:
device:
web: false
mobile: false
server: false
cloud:
web: false
mobile: false
server: false
settings:
- name: apiKey
type: string
defaultValue: ''
description: Find your API key here https://app.userleap.com/settings/installation
required: true
label: API Key
actions: []
presets: []
- destination_id: 5fa3ce52d18ccdfb384b13f7
display_name: Startdeliver
name: Startdeliver
Expand Down Expand Up @@ -31372,61 +31429,6 @@ items:
label: API Key
actions: []
presets: []
- destination_id: 5f2c35239094d175b6485eb1
display_name: UserLeap
name: UserLeap
slug: userleap
hidden: false
regional:
- us-west
url: connections/destinations/catalog/userleap
previous_names:
- UserLeap
website: https://sprig.com
status: PUBLIC_BETA
categories:
- Analytics
- Customer Success
- Personalization
- Surveys
logo:
url: >-
https://public-segment-devcenter-production.s3.amazonaws.com/74f53b6f-bc75-4132-b7de-1170cc57202e.svg
mark:
url: >-
https://public-segment-devcenter-production.s3.amazonaws.com/d761456e-2b15-4401-87da-0c3fde847f5b.svg
methods:
track: true
identify: true
group: false
alias: true
page: true
platforms:
browser: true
mobile: true
server: true
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
replay: false
connection_modes:
device:
web: false
mobile: false
server: false
cloud:
web: false
mobile: false
server: false
settings:
- name: apiKey
type: string
defaultValue: ''
description: Find your API key here https://app.userleap.com/settings/installation
required: true
label: API Key
actions: []
presets: []
- destination_id: 5c75396a02254a0001da2a55
display_name: Userlist
name: Userlist
Expand Down
11 changes: 11 additions & 0 deletions src/_data/catalog/overrides.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# This file is manually generated. When you add or remove an item, add or remove
# it from the `overrides-list.yml` too.
items:
- slug: criteo-app-web-events
connection_modes:
connection_modes:
device:
web: true
mobile: false
server: false
cloud:
web: false
mobile: true
server: false
- slug: doubleclick-floodlight
connection_modes:
device:
Expand Down
Loading

0 comments on commit 275b09f

Please sign in to comment.