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
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -195,7 +195,7 @@ You can see how to write them in the `styleguide.md`, and see how they render at
195
195
196
196
-`dev`: runs `jekyll serve` locally with incremental builds. Useful when updating CSS, JS, or content and you don't want to rebuild everytime.
197
197
-`build`: Builds the site docs. Used by CI to publish the docs to staging and production
198
-
-`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
198
+
-`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. [Instructions here](#bring-your-own-token).
199
199
-`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.
200
200
-`typewriter`: pulls in the current state of the Docs tracking plan for implementing Segment tracking
201
201
-`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 set up an API key.
@@ -299,11 +299,19 @@ $ make catalog
299
299
300
300
##### Bring your own token
301
301
302
-
You create your own token via the Access Management Page. Feel free to use [`segment-engineering`](https://app.segment.com/segment-engineering/settings/access-management) or [`segment_prod`](https://app.segment.com/segment_prod/settings/access-management). Once you have the token, set the value in the `.env` file.
302
+
You create your own token in the Segment App. You can use your own personal workspace, or if you have access to them, use [`segment-engineering`](https://app.segment.com/segment-engineering/settings/access-management) or [`segment_prod`](https://app.segment.com/segment_prod/settings/access-management). Go to **Settings > Access Management > Tokens**.
303
+
Any type of token will work, but you might want to limit it to a read-only token. Make sure you label it so folks know what it's for!
304
+
305
+
Once you make a new token, paste the token value in the `.env` file like so:
306
+
307
+
```text
308
+
PLATFORM_API_TOKEN=(token value here)
309
+
```
310
+
You can now run `make catalog`!
303
311
304
312
305
313
#### Catalog Data + Doc Links
306
-
By default, the links on the catalog page and respective sidenavs will attempt to automagically set hyperlinks, for actual doc file, at the path `connections/:type/:slug`. However, given the transitory state of Docs V2, these links might 404 since the respective doc might be in a different directory.
314
+
By default, the links on the catalog page and respective sidenavs attempt to automagically set hyperlinks, for actual doc file, at the path `connections/:type/:slug`. However, given the transitory state of Docs V2, these links might 404 since the respective doc might be in a different directory.
307
315
308
316
#### Object Sources and Warehouses
309
317
These two catalogs are hardcoded in the `_data` directory since the Config API does not expose these resources.
0 commit comments