Skip to content

Commit 8987af8

Browse files
edwarduptonedwardupton
authored
Merge branch 'master' into littledata-docs-update
2 parents 48d0a59 + 032d443 commit 8987af8

File tree

580 files changed

+33045
-31782
lines changed

Some content is hidden

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

580 files changed

+33045
-31782
lines changed

‎.env.example

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1-
PLATFORM_API_TOKEN=look for me in chamber
2-
PAPI_TOKEN=get one from a papi-enabled workspace
1+
##
2+
# Rename this file .env
3+
##
4+
5+
CONTEXT=development
6+
PLATFORM_API_TOKEN=generate a token from your Segment workspace
7+
PAPI_TOKEN=generate a token from your Segment workspace
8+
ALGOLIA_APP_ID=
9+
ALGOLIA_SEARCH_KEY=

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Segment Support
4+
url: https://segment.com/help/contact/
5+
about: Contact Segment Support for help with product-related issues.

‎.github/ISSUE_TEMPLATE/fix-content.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Improve an existing article's content
2+
description: Make a suggestion to improve the content of an existing article
3+
title: "[Content]: "
4+
labels: [content, triage]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
* Please check that there is not an existing open [issue](https://github.com/segmentio/segment-docs/issues) before you create a new one.
10+
* Read the Contribution guide before you continue.
11+
- type: input
12+
attributes:
13+
label: What article on segment.com/docs is affected?
14+
description: Please paste link to the article you'd like to see updated.
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: What part(s) of the article would you like to see updated?
20+
description: |
21+
- Give as much detail as you can to help us understand the change you want to see.
22+
- Why should the docs be changed? What use cases does it support?
23+
- What is the expected outcome?
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
attributes:
29+
label: Additional information
30+
description: Add any other context or screenshots about the feature request here.
31+
validations:
32+
required: false

‎.github/ISSUE_TEMPLATE/fix-display.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Display bug or other issue
2+
description: Raise an issue related to the display of the site it self, or anything else not related to content.
3+
title: "[Bug]: "
4+
labels: [bug, triage]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
* Please check that there is not an existing open [issue](https://github.com/segmentio/segment-docs/issues) before you create a new one.
10+
* Read the Contribution guide before you continue.
11+
# - type: checkboxes
12+
# id: terms
13+
# attributes:
14+
- type: input
15+
attributes:
16+
label: Where on segment.com/docs did you see this issue?
17+
description: Please paste link to the article where you noticed the issue.
18+
validations:
19+
required: true
20+
- type: dropdown
21+
id: browsers
22+
attributes:
23+
label: What browsers are you seeing the problem on?
24+
multiple: true
25+
options:
26+
- Firefox
27+
- Chrome
28+
- Safari
29+
- Microsoft Edge
30+
- type: textarea
31+
attributes:
32+
label: Please describe the issue.
33+
description: Add any other context or screenshots about the feature request here.
34+
validations:
35+
required: true

‎.github/release.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- automated-reposync-pr
5+
- autoupdate
6+
- back-end
7+
- release
8+
authors:
9+
- bot-docsteam
10+
categories:
11+
- title: New Features
12+
labels:
13+
- new-feature
14+
- title: New Integration Docs
15+
labels:
16+
- new-integration
17+
- title: Improvements
18+
labels:
19+
- enhancement
20+
- title: Fixes
21+
labels:
22+
- fixed-content
23+
- fixed-site
24+
- title: Other Updates
25+
labels:
26+
- "*"

‎.github/workflows/check-links-external.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: CheckLinks
2+
3+
# **What it does**: Runs a weekly check for broken external links.
4+
# **Why we have it**: We want to make sure that pages we link to work.
5+
# **Who does it impact**: Everyone
6+
7+
8+
9+
on:
10+
schedule:
11+
- cron: "5 4 * * SUN"
12+
13+
jobs:
14+
checklinks-external:
15+
if: github.repository == 'segmentio/segment-docs'
16+
name: Linux
17+
runs-on: ubuntu-latest
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
20+
REPORT_AUTHOR: docsbot
21+
REPORT_LABEL: report, automated issue, broken links
22+
REPORT_REPOSITORY: segmentio/segment-docs
23+
strategy:
24+
fail-fast: false
25+
steps:
26+
- uses: actions/checkout@v2
27+
- name: Ruby
28+
uses: ruby/setup-ruby@v1
29+
with:
30+
ruby-version: 2.6 # Not needed with a .ruby-version file
31+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
32+
- name: Yarn install
33+
run: yarn install
34+
- name: Build jekyll website with
35+
run: bundle exec jekyll build
36+
- name: Run Script
37+
run: |
38+
sudo make linkcheck-external > broken_links.md
39+
- if: ${{ failure() }}
40+
name: Create issue from file
41+
id: broken-link-report
42+
uses: peter-evans/create-issue-from-file@b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e
43+
with:
44+
token: ${{ env.GITHUB_TOKEN }}
45+
46+
title: Broken Links Report - External
47+
content-filepath: ./broken_links.md
48+
repository: ${{ env.REPORT_REPOSITORY }}
49+
labels: ${{ env.REPORT_LABEL }}

‎.github/workflows/check-links-internal.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: CheckLinks
2+
3+
# **What it does**: Runs a weekly check for broken internal links.
4+
# **Why we have it**: We want to make sure that pages we link to work.
5+
# **Who does it impact**: Everyone
6+
7+
8+
9+
on:
10+
schedule:
11+
- cron: "5 4 * * SAT"
12+
13+
jobs:
14+
checklinks-internal:
15+
if: github.repository == 'segmentio/segment-docs'
16+
name: Linux
17+
runs-on: ubuntu-latest
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
20+
REPORT_AUTHOR: docsbot
21+
REPORT_LABEL: report, automated issue, broken links
22+
REPORT_REPOSITORY: segmentio/segment-docs
23+
strategy:
24+
fail-fast: false
25+
steps:
26+
- uses: actions/checkout@v2
27+
- name: Ruby
28+
uses: ruby/setup-ruby@v1
29+
with:
30+
ruby-version: 2.6 # Not needed with a .ruby-version file
31+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
32+
- name: Yarn install
33+
run: yarn install
34+
- name: Build jekyll website with
35+
run: bundle exec jekyll build
36+
- name: Run Script
37+
run: |
38+
sudo make linkcheck-internal > broken_links.md
39+
- if: ${{ failure() }}
40+
name: Create issue from file
41+
id: broken-link-report
42+
uses: peter-evans/create-issue-from-file@b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e
43+
with:
44+
token: ${{ env.GITHUB_TOKEN }}
45+
46+
title: Broken Links Report - Local
47+
content-filepath: ./broken_links.md
48+
repository: ${{ env.REPORT_REPOSITORY }}
49+
labels: ${{ env.REPORT_LABEL }}

‎.github/workflows/link-check.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎.github/workflows/merged-notification.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Merged notification
2+
3+
# **What it does**: When we merge an open-source pull request, we want to set expectations that deployment may take awhile.
4+
# **Why we have it**: Merged PRs go into a queue, not straight to build.
5+
# **Who does it impact**: Open-source contributors.
6+
7+
on:
8+
pull_request_target:
9+
types:
10+
- 'closed'
11+
12+
jobs:
13+
comment:
14+
if: github.repository == 'segmentio/segment-docs' && github.event.pull_request.merged && github.event.pull_request.base.ref == github.event.repository.default_branch
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
18+
with:
19+
script: |
20+
github.issues.createComment({
21+
...context.repo,
22+
issue_number: context.payload.pull_request.number,
23+
body: "Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site."
24+
})

‎.github/workflows/repo-sync.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Repo Sync
2+
3+
on:
4+
schedule:
5+
- cron: "*/30 * * * *" # every 30 minutes.
6+
7+
jobs:
8+
repo-sync:
9+
name: Repo Sync
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
14+
- uses: repo-sync/github-sync@v2
15+
name: Sync repo to branch
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
18+
with:
19+
source_repo: ${{ secrets.SOURCE_REPO }}
20+
source_branch: ${{ secrets.SOURCE_BRANCH }}
21+
destination_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
22+
github_token: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
23+
24+
- uses: repo-sync/pull-request@v2
25+
name: Create pull request
26+
env:
27+
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
28+
with:
29+
source_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
30+
destination_branch: ${{ secrets.DESTINATION_BRANCH }}
31+
pr_title: 'repo sync'
32+
pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!"
33+
pr_label: autoupdate,automated-reposync-pr
34+
github_token: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
35+
36+
- name: Find pull request
37+
uses: juliangruber/find-pull-request-action@v1
38+
id: find-pull-request
39+
with:
40+
github-token: ${{ secrets.GITHUB_TOKEN }}
41+
branch: repo-sync
42+
base: ${{ secrets.DESTINATION_BRANCH }}
43+
author: bot-docsteam
44+
state: open
45+
46+
- name: Approve pull request
47+
if: ${{ steps.find-pull-request.outputs.number }}
48+
uses: juliangruber/approve-pull-request-action@v1
49+
with:
50+
github-token: ${{ secrets.GITHUB_TOKEN }}
51+
number: ${{ steps.find-pull-request.outputs.number }}
52+
53+
- name: Merge Pull Request
54+
if: ${{ steps.find-pull-request.outputs.number }}
55+
uses: juliangruber/merge-pull-request-action@v1
56+
with:
57+
github-token: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
58+
number: ${{ steps.find-pull-request.outputs.number }}
59+
method: merge

‎.github/workflows/stale-check.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: 60 Days Stale Check
2+
3+
# **What it does**: Pull requests older than 60 days will be flagged as stale.
4+
# **Why we have it**: We want to manage our queue of issues and pull requests.
5+
# **Who does it impact**: Everyone who responds to issues and PRs.
6+
7+
on:
8+
schedule:
9+
- cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST
10+
11+
jobs:
12+
stale:
13+
if: github.repository == 'segmentio/segment-docs'
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da
17+
with:
18+
repo-token: ${{ secrets.GITHUB_TOKEN }}
19+
stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'
20+
stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
21+
days-before-stale: 60
22+
days-before-close: -1
23+
only-labels: 'triage'
24+
stale-issue-label: 'stale'
25+
stale-pr-label: 'stale'
26+
exempt-pr-labels: 'never-stale'
27+
exempt-issue-labels: 'never-stale'

0 commit comments

Comments
 (0)