Skip to content

Commit fda34d9

Browse files
authored
Merge branch 'master' into dest-1616
2 parents fb03224 + e240e5b commit fda34d9

File tree

9 files changed

+2974
-2845
lines changed

9 files changed

+2974
-2845
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ You can see how to write them in the `styleguide.md`, and see how they render at
195195

196196
- `dev`: runs `jekyll serve` locally with incremental builds. Useful when updating CSS, JS, or content and you don't want to rebuild everytime.
197197
- `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).
199199
- `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.
200200
- `typewriter`: pulls in the current state of the Docs tracking plan for implementing Segment tracking
201201
- `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
299299

300300
##### Bring your own token
301301

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`!
303311

304312

305313
#### 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.
307315

308316
#### Object Sources and Warehouses
309317
These two catalogs are hardcoded in the `_data` directory since the Config API does not expose these resources.

0 commit comments

Comments
 (0)