Skip to content

Commit 25b7546

Browse files
authored
Start migration (#240)
* Checkin: refresh all the easy stuff. * config api * spec migration * raw migration of destinations files * raw migration of destinations files * replace old dest filters doc with recently migrated one Signed-off-by: sanscontext <[email protected]> * copy raw partials from site-docs * useful file! * Pull in guides. * move bulk data storage to warehouses path. * reorder guides holy crap * Revert whoops in partials dir * merge markdown partials, will rectify last ones Monday * Migrate handlebars partials to liquid * Comment out api-example handlebars tool invocations * Migrate single instance of youtube helper. * comment out two instances of snippet helper * Replace removed examples with vanilla js blobs * formatting typo * format typo whoops * Source catalog structure fixed * fix formatting * Edits on Cloud source intro * preemtively fix some links where I can * image migration for guides about and bps * image fixes on the usage guides. * small fixes * start removing unused frontmatter flags * restore lost catalog page * remove unused 'sidebar' frontmatter * Root guides images fixed * more image fixes * More image fixes * Per Sperandio, these are okay to delete. * remove links to removed files * redirect these to spec per sperandio * First shot at regenerating sidenav * guides rejiggering
1 parent 65ad488 commit 25b7546

File tree

1,047 files changed

+16026
-11116
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,047 files changed

+16026
-11116
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ You will need to have Docker installed https://docs.docker.com/install/
2424
- `build`: Builds the site docs. Used by CI to publish the docs to staging and production
2525
- `catalog`: Pulls in the latest catalog data from the Platform API and saves it in the respective data files. Requires an API key to be passed in env via PLATFORM_API_TOKEN
2626
- `sidenav`: Builds the side navs for 'main', 'legal', 'api', 'partners' and stores the output in `/src/_data/sidenav-auto/`. This output isn't used for the actual build.
27-
- `typewritter`: pulls in the current state of the Docs tracking plan for implementing Segment tracking
27+
- `typewriter`: pulls in the current state of the Docs tracking plan for implementing Segment tracking
2828
- `seed`: copies all example data files out of the `_templates` directory and puts them in the `_data` directory. Useful if you don't have a way to setup an API key.
2929
- `clean`: removes all build artifacts
30-
- `clean-deps`: removes all doownloaded `gems` and `node_modules`
30+
- `clean-deps`: removes all downloaded `gems` and `node_modules`
3131
- `deps`: installs the required `gems` and `node_modules`
3232
- `dev`: runs `jekyll serve` locally with incremental builds. Useful when updating CSS, JS, or content and you don't want to rebuild everytime.
3333

src/404.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<div class="page-404">
2020
<div class="flex">
2121
<div class="flex__column--12 flex__column--9@xlarge">
22-
<h1 class="page-404__heading">The page you were looking for doesnt exist.</h1>
22+
<h1 class="page-404__heading">The page you were looking for doesn't exist.</h1>
2323
<div class="flex">
2424
<div class="flex__column--12 flex__column--10@xlarge markdown">
2525
<p>You may have mistyped the address or the page may have moved. Double-check the URL and try again or search the term.</p>

src/_data/catalog/destinations.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11259,7 +11259,7 @@ items:
1125911259
string_validators:
1126011260
regexp: ''
1126111261
description: >-
11262-
To find your API key, log into Pendo and navigate to your user name >
11262+
To find your API key, log into Pendo and navigate to "your user name" >
1126311263
Site settings > Basic Information > API key. If your account has not fully
1126411264
been set up yet, you can see the API key inside of the code snippet on the
1126511265
Pendo setup page.
@@ -14087,11 +14087,11 @@ items:
1408714087
string_validators:
1408814088
regexp: '^.{8,}$'
1408914089
description: >-
14090-
To find your key, log into Split and navigate to Admin Settings >
14091-
Integrations > select your desired workspace > Segment. There you can
14090+
To find your key, log into Split and navigate to "Admin Settings" >
14091+
"Integrations" > select your desired workspace > "Segment". There you can
1409214092
find the key for each configured integration. If you don’t have an
1409314093
integration configured, be sure to configure your integration in the
14094-
section Configure as a destination in Segment and click save to generate
14094+
section "Configure as a destination in Segment" and click save to generate
1409514095
a key. For more information, learn more in Split’s [integration
1409614096
documentation](https://segment.com/docs/destinations/split/).
1409714097
settings: []
@@ -15264,7 +15264,7 @@ items:
1526415264
string_validators:
1526515265
regexp: '^[a-zA-Z0-9]*$'
1526615266
description: >-
15267-
Drop in the Integration Key into your Segment Settings UI which you can
15267+
Drop in the "Integration Key" into your Segment Settings UI which you can
1526815268
find on https://businessapp.b2b.trustpilot.com/#/ecommerce/segment
1526915269
settings: []
1527015270
connection_modes:

src/_data/catalog/incompleteDocs.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ src/connections/sources/catalog/cloud-apps/airship
33
src/connections/sources/catalog/cloud-apps/launchdarkly
44
src/connections/sources/catalog/cloud-apps/pendo
55
src/connections/sources/catalog/cloud-apps/project
6-
src/connections/sources/catalog/libraries/website/shopify-by-littledatasrc/connections/destinations/catalog/adlearn-open-platform
6+
src/connections/sources/catalog/libraries/website/shopify-by-littledata
7+
src/connections/destinations/catalog/adlearn-open-platform
78
src/connections/destinations/catalog/adquick
89
src/connections/destinations/catalog/airship
910
src/connections/destinations/catalog/amazon-eventbridge

src/_data/glossary.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ JSON: |
5656
Library: |
5757
A library is a reusable piece of code which acts as a building block for higher level pieces of code. It's the software equivalent of a 'tool'. For instance, take Instagram filters. In the good old days, to take a picture with an interesting filter, you had to adjust the aperture length, the focal length, the exposure and film speed to get the desired effect. But now, you can just use Instagram, and press a button to get the pre-tuned filter that you want. They've packaged those effects in software and made them re-usable.
5858
59-
The most common use case for this term at Segment is in reference to the libraries people use to send data to our API. [A full list of libraries can be found in our docs](https://segment.com/docs/libraries/). Libraries are either [Client Side](#Client-Side) or [Server Side](#Server-Side).
59+
The most common use case for this term at Segment is in reference to the libraries people use to send data to our API. [A full list of libraries can be found in our docs](https://segment.com/docs/libraries/). Libraries are either "[Client Side](#Client-Side)" or "[Server Side](#Server-Side)".
6060
6161
Method: |
6262
A method is programming speak for "an action an object can take". It's a specific type of function that is attached to an object. All of our analytics tracking libraries create `analytics` objects, and then `track`, `identify`, `page`, etc. are methods you can invoke on those objects.
@@ -88,7 +88,7 @@ Schema: |
8888
In Segment, you can send data to a Warehouse which has a schema based on the types of data you collect and route through Segment, and which updates as the data you collect changes.
8989
9090
Server Side: |
91-
Refers to a group of libraries that can send data to Segment. This could also could refer to people sending data directly to [our API](https://segment.com/docs/libraries/http/) without using a library. Usually used in contrast to [Client Side](#Client-Side).
91+
Refers to a group of libraries that can send data to Segment. This could also could refer to people sending data directly to [our API](https://segment.com/docs/libraries/http/) without using a "library". Usually used in contrast to [Client Side](#Client-Side).
9292
9393
*Server-side libraries* run on a server and are completely invisible to end users. Find the full list of server-side languages Segment supports [in our docs](https://segment.com/docs/libraries/#server). These libraries can be used to track a user in realtime as they use your app, but are also able to run batches of calls to update many end users at once. Server-side libraries do not maintain "state" which means every API call you make must include every detail you want to see inside of Segment.
9494

src/_data/landing.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
- name: Guides
1+
- name: Getting Started
22
icon: icon-guides.svg
33
description: "Start here! Best practices, Setup steps, and other useful information."
44
path: /guides/
55

6-
- name: Academy
6+
- name: How-to Guides
77
icon: icon-academy.svg
88
description: "Learn more about the 'whys' and 'hows' of analytics. A great read if you're just getting started."
9-
path: /academy/
9+
path: /guides/best-practices/
1010

1111
- name: App
1212
icon: icon-app.svg

src/_data/sidenav/_auto/legal.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ sections:
55
title: Terms of Service
66
- path: /legal/acceptable-use-policy
77
title: Acceptable Use Policy
8+
- path: /legal/enhanced-onboarding-support
9+
title: Enhanced Onboarding Support
810
- path: /legal/first-access-beta-preview
911
title: First-Access and Beta Preview
1012
- path: /legal/partnersagreement
@@ -35,7 +37,5 @@ sections:
3537
title: Terms of Service - 2017
3638
- path: /legal/terms-updates
3739
title: Updates - Terms of Service
38-
- path: /legal/terms
39-
title: Terms of Service
4040
- path: /legal/website-data-collection-policy
4141
title: Website Data Collection Policy

0 commit comments

Comments
 (0)