From e3c16e1793949d41aed48f8871b909fdabbf8b3e Mon Sep 17 00:00:00 2001 From: Abin Simon Date: Thu, 20 Oct 2022 21:33:07 +0530 Subject: [PATCH] Rename tutorial to quickstart (#1250) ## Description There was a missed link to tutorial in main page in https://github.com/alcionai/corso/pull/1245. Fixes that. Also enabled docs build (not push) for docs in CI as that is pretty fast anyways. Fixes `Push-Docs` job failing in `main`. ## Type of change - [ ] :sunflower: Feature - [ ] :bug: Bugfix - [x] :world_map: Documentation - [ ] :robot: Test - [ ] :computer: CI/Deployment - [ ] :hamster: Trivial/Minor ## Issue(s) * # ## Test Plan - [x] :muscle: Manual - [ ] :zap: Unit test - [x] :green_heart: E2E --- .github/workflows/ci.yml | 16 +++++++++------- docs/src/pages/index.js | 4 ++-- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ff67dfc65..036b7e816 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -198,7 +198,6 @@ jobs: SetEnv: environment: Testing - if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' runs-on: ubuntu-latest outputs: environment: ${{ steps.set-env.outputs.environment }} @@ -259,7 +258,7 @@ jobs: needs: [Test-Suite, Linting, Docs-Linting, SetEnv] environment: ${{ needs.SetEnv.outputs.environment }} runs-on: ubuntu-latest - if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' + if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' || needs.precheck.outputs.docfileschanged == 'true' # docsfileschanged also includes srcfileschanged defaults: run: working-directory: docs @@ -273,24 +272,27 @@ jobs: name: cli-docs path: docs/docs/cli + - name: Build docs + run: | + npm ci + CORSO_DOCS_BASEURL="/preview/" npm run build # TODO: update base url once finalized + - name: Configure AWS credentials from Test account + if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' uses: aws-actions/configure-aws-credentials@v1 with: role-to-assume: ${{ secrets.AWS_IAM_ROLE }} role-session-name: integration-testing aws-region: us-east-1 - - name: Build docs - run: | - npm ci - CORSO_DOCS_BASEURL="/preview/" npm run build # TODO: update base url once finalized - - name: Push docs + if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' run: | echo "$DOCS_BUCKET" | base64 aws s3 sync build "s3://${{ secrets.DOCS_S3_BUCKET }}/preview" - name: Invalidate cloudfront + if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' run: | aws cloudfront create-invalidation --distribution-id ${{ secrets.DOCS_CF_DISTRIBUTION }} --paths "/*" diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index ec6d11398..8e34c1deb 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -16,8 +16,8 @@ function HomepageHeader() {
- Corso Tutorial - 5min ⏱️ + to="quickstart"> + Corso Quickstart - 5min ⏱️