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
* 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 (#2437)
* Add clarity to HubSpot API limit (#2436)
* Update CONTRIBUTING.md
* catalog update
* Add Troubleshooting section to GEC docs (#2434)
* add Troubleshooting section to GEC docs
* style edits
Co-authored-by: markzegarelli <[email protected]>
* redirect sprig actions (#2423)
* remove connection table
* Linking to FQL from Destination Filters doc (#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… (#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 (#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]>
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Before you begin:
10
10
11
11
## Use the contribution links from any docs page
12
12
13
-
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.
13
+
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.
14
14
15
15
## Want to go deeper? Fork the repository
16
16
@@ -39,7 +39,7 @@ The most interesting ones are:
39
39
40
40
### Images
41
41
42
-
**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.
42
+
**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.
43
43
44
44
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.
45
45
@@ -77,11 +77,11 @@ Sources pages check if the source is a cloud-app, then include information about
77
77
78
78
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).
79
79
80
-
### Frontmatter
80
+
### Front matter
81
81
82
-
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.
82
+
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.
83
83
84
-
Frontmatter in a file will look something like this:
84
+
Front matter in a file will look something like this:
85
85
86
86
```md
87
87
---
@@ -90,25 +90,25 @@ hide-feedback: false
90
90
---
91
91
```
92
92
93
-
Each piece of frontmatter does something special!
93
+
Front matter variables have unique functions, including the following:
94
94
95
-
#### Content-related frontmatter
95
+
#### Content-related front matter
96
96
-`beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta-note.md`)
97
-
-`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.
97
+
-`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.
98
98
-`hide-dossier`: defaults to false. When true, hides the "quick info" box at the top of a destination page.
99
99
-`hide-boilerplate`: defaults to false. When true, none of the content from `destination-footer.md` is appended to the destination page.
100
100
-`hide-cmodes`: defaults to false. A renaming of "rewrite" for more clarity, hides the connection modes table in the boilerplate.
101
101
-`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.
102
102
-`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.
103
103
-`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.
104
104
105
-
#### Utility frontmatter
105
+
#### Utility front matter
106
106
-`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.
107
107
-`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.
108
108
-`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.
109
109
-`hide-feedback`: defaults to false. When true, hide the feedback in both rnav and footer. Good for landing pages.
110
110
-`hide_toc`: hides the right-nav TOC that's generated from H2s. Also good for landing pages.
111
111
-`landing`: defaults to false. Use this to drop the noun set by `integration_type` from the tab title.
112
-
-`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.
112
+
-`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.
113
113
-`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.
114
114
-`seo-priority`: values from `1.0` to `0.1`, default: `0.5 `. Sets the `Priority` tag in the sitemap
0 commit comments