Skip to content

Commit 2a91c73

Browse files
committed
ready for default branch switch
1 parent 484db38 commit 2a91c73

File tree

4 files changed

+14
-10
lines changed

4 files changed

+14
-10
lines changed

.github/workflows/repo-sync.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
1818
with:
1919
source_repo: ${{ secrets.SOURCE_REPO }}
20-
source_branch: master
20+
source_branch: ${{ secrets.SOURCE_BRANCH }}
2121
destination_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
2222
github_token: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
2323

@@ -27,7 +27,7 @@ jobs:
2727
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
2828
with:
2929
source_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
30-
destination_branch: master
30+
destination_branch: ${{ secrets.DESTINATION_BRANCH }}
3131
pr_title: 'repo sync'
3232
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!"
3333
pr_label: autoupdate,automated-reposync-pr
@@ -39,7 +39,7 @@ jobs:
3939
with:
4040
github-token: ${{ secrets.GITHUB_TOKEN }}
4141
branch: repo-sync
42-
base: master
42+
base: ${{ secrets.DESTINATION_BRANCH }}
4343
author: bot-docsteam
4444
state: open
4545

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Not all pages have a 1-1 mapping with their location within the repository. This
1414

1515
## Want to go deeper? Fork the repository
1616

17-
You can fork this repository to your local machine to make larger changes. Examples of larger changes include:
17+
You can fork this repository and clone it to your local machine to make larger changes. Examples of larger changes include:
1818
- editing more than one file at a time
1919
- adding or updating images
2020
- updating navigation items
2121

22-
In this scenario, you'll fork the repository locally, make your changes, and submit a pull request to have them reviewed and merged back into the site.
22+
In this scenario, you'll fork the repository, clone it locally, make your changes, and submit a pull request to have them reviewed and merged back into the site.
2323

2424
## Site structure
2525

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,21 @@ In this article, find information about:
1616

1717
## Contributing
1818

19-
The Segment docs team accepts a few types of contribution, including:
19+
The Segment docs team accepts contributions in the form of issues and pull requests.
20+
21+
All accepted contributions, in the form of approved pull requests and resolved issues, are deployed twice weekly, on Tuesday and Thursdays. As a result, once your pull request is closed, or your issue resolved, you may not see these changes on the site immediately.
2022

2123
### Issues
2224

2325
If you see an error or something incorrect on a specific page, click Request docs change to create an issue to bring it to the team’s attention.
2426

2527
### Pull Requests
2628

27-
If you would like to update the documentation yourself, create a Pull Request to bring it to the team’s attention. Click Edit this page to edit the page directly on GitHub. Alternatively, you can clone the repository and submit your Pull Request that way. For more information, see Contributing and the Developer Guide
29+
If you would like to update the documentation yourself, create a Pull Request to bring it to the team’s attention. Click Edit this page to edit the page directly on GitHub. Alternatively, you can clone the repository and submit your Pull Request that way. For more information, see [Contributing](CONTRIBUTING.md) and the [Developer Guide](devguide.md)
30+
31+
32+
2833

29-
For more information about contributing, see [Contributing](CONTRIBUTING.md).
3034

3135
## List of READMEs
3236

devguide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If using OSX:
1616

1717
## All about the Catalog script
1818

19-
You run the Catalog update script by running `make catalog` from the docs repo. You, a person who is going to run the script, must first save a Segment token to an `.env` file locally, which is `gitignored` so we don’t check it in to gihub accidentally.
19+
You run the Catalog update script by running `make catalog` from the docs repo. You, a person who is going to run the script, must first save a Segment token to an `.env` file locally, which is `gitignored` so we don’t check it in to GitHub accidentally.
2020

2121
Note: Old ConfigAPI tokens are not compatible with Public API. You'll need a new one if you want to use Public API.
2222

@@ -33,7 +33,7 @@ It also does some slugification and destination-name normalization, since our ha
3333

3434
### 3.1. <a name='Layouts'></a>Layouts
3535

36-
`default.html` is the base container through which all the individual other layouts are built to have the right title, seo, etc. The template inheritance is described in the diagram below.
36+
`default.html` is the base container through which all the individual other layouts are built to have the right title, SEO, etc. The template inheritance is described in the diagram below.
3737

3838
The `destination.html`, `source.html`, and `integration.html` templates contain the logic that runs the layouts for individual catalog pages. Storage/warehouses use the generic Integration right now because they don't need anything special. Set the layout in the Jekyll `_config.yml` file.
3939

0 commit comments

Comments
 (0)