Merge pull request #1945 from segmentio/develop

Develop

Author: markzegarelli

.github/workflows/repo-sync.yml

@@ -17,7 +17,7 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
       with:
         source_repo: ${{ secrets.SOURCE_REPO }}
-        source_branch: master
+        source_branch: ${{ secrets.SOURCE_BRANCH }}
         destination_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
         github_token: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
 
@@ -27,7 +27,7 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SCOPE }}
       with:
         source_branch: ${{ secrets.INTERMEDIATE_BRANCH }}
-        destination_branch: master
+        destination_branch: ${{ secrets.DESTINATION_BRANCH }}
         pr_title: 'repo sync'
         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!"
         pr_label: autoupdate,automated-reposync-pr
@@ -39,7 +39,7 @@ jobs:
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
         branch: repo-sync
-        base: master
+        base: ${{ secrets.DESTINATION_BRANCH }}
         author: bot-docsteam 
         state: open
 

CONTRIBUTING.md

@@ -14,12 +14,12 @@ Not all pages have a 1-1 mapping with their location within the repository. This
 
 ## Want to go deeper? Fork the repository
 
-You can fork this repository to your local machine to make larger changes. Examples of larger changes include:
+You can fork this repository and clone it to your local machine to make larger changes. Examples of larger changes include:
 - editing more than one file at a time
 - adding or updating images
 - updating navigation items
 
-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.
+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.
 
 ## Site structure
 

README.md

@@ -3,6 +3,8 @@
 
 Here, you can contribute to the Segment Documentation site.
 
+**Note**: On Friday, October 1st, the default branch of this repository was changed from `master` to `develop`. If you have a fork of `segment-docs`, please ensure the default branch of the fork is updated accordingly.
+
 ## Overview
 
 This repository contains the documentation website code and source files for https://segment.com/docs.
@@ -16,17 +18,21 @@ In this article, find information about:
 
 ## Contributing
 
-The Segment docs team accepts a few types of contribution, including:
+The Segment docs team accepts contributions in the form of issues and pull requests.
+
+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.
 
 ### Issues
 
 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.
 
 ### Pull Requests
 
-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
+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)
+
+
+
 
-For more information about contributing, see [Contributing](CONTRIBUTING.md).
 
 ## List of READMEs
 

devguide.md

@@ -4,7 +4,7 @@ The contents of this guide will help you get up and running with the Segment Doc
 
 ## Local development with `ruby` and `node`, without Config API
 
-If using OSX:
+If using MacOS:
   * Install command line tools, `xcode-select --install`
   * Install `Ruby` >= 2.3.0 https://www.ruby-lang.org/en/documentation/installation/
   * Ensure you're running `RubyGems` >= 2.5.0 by running `gem update --system` followed by `gem --version`
@@ -16,7 +16,7 @@ If using OSX:
 
 ##  All about the Catalog script
 
-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.
+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.
 
 Note: Old ConfigAPI tokens are not compatible with Public API. You'll need a new one if you want to use Public API.
 
@@ -33,7 +33,7 @@ It also does some slugification and destination-name normalization, since our ha
 
 ###  3.1. <a name='Layouts'></a>Layouts
 
-`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.
+`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.
 
 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.