From a3bc773429d28ccb90403eb7326493768ea27843 Mon Sep 17 00:00:00 2001 From: Jan Dvorak Date: Tue, 26 Oct 2021 20:57:09 +0200 Subject: [PATCH 1/4] Update Guide readme --- guide/Contributing.md | 3 --- guide/README.md | 11 +++++------ 2 files changed, 5 insertions(+), 9 deletions(-) delete mode 100644 guide/Contributing.md diff --git a/guide/Contributing.md b/guide/Contributing.md deleted file mode 100644 index 1b868764f6..0000000000 --- a/guide/Contributing.md +++ /dev/null @@ -1,3 +0,0 @@ -## Contributing to Meteor Documentation - -Please read the [Meteor documentation contribution guide](https://github.com/meteor/docs/blob/master/Contributing.md). diff --git a/guide/README.md b/guide/README.md index b46dae030f..94f25a6fa0 100644 --- a/guide/README.md +++ b/guide/README.md @@ -1,6 +1,6 @@ -# Static Site Shell (WIP) +# Meteor Guide -This is a setup to generate a static site from the markdown files location in `/content` using [Hexo](https://hexo.io/). +This is a setup to generate a static site from the markdown files location in `/source` using [Hexo](https://hexo.io/). ### Notes on Content Authoring @@ -15,21 +15,20 @@ git submodule update --init npm install -g hexo-cli -# in /site npm install # serve at localhost:4000 hexo server ``` -The static site theme is in `themes/meteor` and is responsible for the visual representation of the site. For more information, check out the [Hexo docs](https://hexo.io/docs/index.html). +The static site theme is `meteor`, loaded from an npm package, is responsible for the visual representation of the site. For more information, check out the [Hexo docs](https://hexo.io/docs/index.html). ### Continuous Deployment -- The `master` branch is automatically deployed to the root of the S3 bucket on every push. +- `devel` is automatically deployed as the production site via Netlify. - Any branch that starts with `version-` will be automatically deployed in a sub-folder on every push. A branch with the name `version-1.2` will be deployed under the `v1.2` folder. -- To make a branch available in the site's version selection dropdown, make sure to add it to the `versions` list in `site/_config.yaml`! +- To make a branch available in the site's version selection dropdown, make sure to add it to the `versions` list in `_config.yaml`! - Any other branch is ignored by default. If you want to enable auto-deploy for a branch, you should edit [the branch field in the deployment section of `circle.yml`](https://github.com/meteor/guide/blob/master/circle.yml#L18) to match the name of the branch. The branch will be then be deployed with the `branch-` prefix automatically. For example, branch `test` will be deployed under the `branch-test` folder. From 339ea88b1af04b450214c0217c18d59dd11ea09c Mon Sep 17 00:00:00 2001 From: Jan Dvorak Date: Tue, 26 Oct 2021 21:01:21 +0200 Subject: [PATCH 2/4] Update more info --- docs/Contributing.md | 4 ---- guide/README.md | 4 +++- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/Contributing.md b/docs/Contributing.md index f68c8f5671..b3a6637eff 100644 --- a/docs/Contributing.md +++ b/docs/Contributing.md @@ -25,7 +25,3 @@ Larger changes like section rewrites, new sections, and even entirely new articl If you make larger contributions to the above properties, you may be invited to become a community documentation maintainer. This is both a recognition of your contribution (thank you!) and the granting of commit rights on the above repositories. With those rights you can merge the Pull Requests of others as well as commit directly to the repository (and in some cases deploy the site). So please use your discretion and be courteous. - -### Current community maintainers - -- [Loren Sands-Ramshaw](http://github.com/lorensr) diff --git a/guide/README.md b/guide/README.md index 94f25a6fa0..100569c954 100644 --- a/guide/README.md +++ b/guide/README.md @@ -30,7 +30,9 @@ The static site theme is `meteor`, loaded from an npm package, is responsible fo - To make a branch available in the site's version selection dropdown, make sure to add it to the `versions` list in `_config.yaml`! -- Any other branch is ignored by default. If you want to enable auto-deploy for a branch, you should edit [the branch field in the deployment section of `circle.yml`](https://github.com/meteor/guide/blob/master/circle.yml#L18) to match the name of the branch. The branch will be then be deployed with the `branch-` prefix automatically. For example, branch `test` will be deployed under the `branch-test` folder. +- Pull Requests will generate deploy previews. + +- All other branches are ignored. ### Manual Deployment From af74ebd8f4d853a11541e413f5f32845d1cf1058 Mon Sep 17 00:00:00 2001 From: Jan Dvorak Date: Wed, 27 Oct 2021 10:22:18 +0200 Subject: [PATCH 3/4] Fix GitHub action --- .github/workflows/docs.yml | 30 ------------------------------ .github/workflows/guide.yml | 34 ++-------------------------------- 2 files changed, 2 insertions(+), 62 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8a71461b55..168b487427 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -30,33 +30,3 @@ jobs: env: NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DOCS_SITE_ID }} - deploy-branch: - runs-on: ubuntu-latest - defaults: - run: - working-directory: docs/ - if: - contains(' - refs/heads/release- - ', github.ref) - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 - with: - node-version: 12.x - - name: Build the Docs - run: npm ci && npm run build - - name: Deploy to Netlify for preview - uses: nwtgck/actions-netlify@v1.2.2 - with: - publish-dir: './docs/public' - production-branch: devel - github-token: ${{ secrets.GITHUB_TOKEN }} - deploy-message: Deploy from GitHub Actions ${{ github.event.pull_request.title }} - netlify-config-path: './docs/netlify.toml' - alias: ${{ github.head_ref }} - enable-pull-request-comment: false - enable-commit-comment: false - env: - NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DOCS_SITE_ID }} diff --git a/.github/workflows/guide.yml b/.github/workflows/guide.yml index b4c00822e5..2c89758c91 100644 --- a/.github/workflows/guide.yml +++ b/.github/workflows/guide.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest defaults: run: - working-directory: guide/site/ + working-directory: guide/ steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 @@ -19,7 +19,7 @@ jobs: - name: Deploy to Netlify for preview uses: nwtgck/actions-netlify@v1.2.2 with: - publish-dir: './guide/site/public' + publish-dir: './guide/public' production-branch: devel github-token: ${{ secrets.GITHUB_TOKEN }} deploy-message: Deploy from GitHub Actions ${{ github.event.pull_request.title }} @@ -30,34 +30,4 @@ jobs: env: NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} NETLIFY_SITE_ID: ${{ secrets.NETLIFY_GUIDE_SITE_ID }} - deploy-branch: - runs-on: ubuntu-latest - defaults: - run: - working-directory: guide/site/ - if: - contains(' - refs/heads/release- - ', github.ref) - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v1 - with: - node-version: 12.x - - name: Build the Guide - run: npm ci && npm run build - - name: Deploy to Netlify for preview - uses: nwtgck/actions-netlify@v1.2.2 - with: - publish-dir: './guide/site/public' - production-branch: devel - github-token: ${{ secrets.GITHUB_TOKEN }} - deploy-message: Deploy from GitHub Actions ${{ github.event.pull_request.title }} - netlify-config-path: './guide/netlify.toml' - alias: ${{ github.head_ref }} - enable-pull-request-comment: false - enable-commit-comment: false - env: - NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_GUIDE_SITE_ID }} From 6331f5be8cdaaaf3a75640ddf4b4bcd83985b21a Mon Sep 17 00:00:00 2001 From: Jan Dvorak Date: Wed, 27 Oct 2021 10:26:12 +0200 Subject: [PATCH 4/4] Add labeler for Guide --- .github/labeler.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/labeler.yml b/.github/labeler.yml index 4ad28f9443..b99cd8fb97 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -115,3 +115,6 @@ Project:Dynamic Import: Project:Docs: - docs/**/* + +Project:Guide: + - guide/**/*