diff --git a/.github/workflows/superset-docs.yml b/.github/workflows/superset-docs-deploy.yml similarity index 81% rename from .github/workflows/superset-docs.yml rename to .github/workflows/superset-docs-deploy.yml index e1c2df7d126..f474a881579 100644 --- a/.github/workflows/superset-docs.yml +++ b/.github/workflows/superset-docs-deploy.yml @@ -1,15 +1,11 @@ -name: Docs +name: Docs Deployment on: push: paths: - "docs/**" branches: - - 'master' - pull_request: - paths: - - "docs/**" - types: [synchronize, opened, reopened, ready_for_review] + - "master" jobs: config: @@ -51,9 +47,9 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.SUPERSET_SITE_BUILD }} with: - source-directory: './docs/build' - destination-github-username: 'apache' - destination-repository-name: 'superset-site' - target-branch: 'asf-site' + source-directory: "./docs/build" + destination-github-username: "apache" + destination-repository-name: "superset-site" + target-branch: "asf-site" commit-message: "deploying docs: ${{ github.event.head_commit.message }} (apache/superset@${{ github.sha }})" user-email: dev@superset.apache.org diff --git a/.github/workflows/superset-docs-verify.yml b/.github/workflows/superset-docs-verify.yml new file mode 100644 index 00000000000..26427c54d9b --- /dev/null +++ b/.github/workflows/superset-docs-verify.yml @@ -0,0 +1,29 @@ +name: Docs Testing + +on: + pull_request: + paths: + - "docs/**" + types: [synchronize, opened, reopened, ready_for_review] +jobs: + build-deploy: + name: Build & Deploy + runs-on: ubuntu-20.04 + defaults: + run: + working-directory: docs + steps: + - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )" + uses: actions/checkout@v3 + with: + persist-credentials: false + submodules: recursive + - name: yarn install + run: | + yarn install --check-cache + - name: yarn typecheck + run: | + yarn typecheck + - name: yarn build + run: | + yarn build diff --git a/docs/src/components/SectionHeader.tsx b/docs/src/components/SectionHeader.tsx index c868b4097aa..10eedaa41c2 100644 --- a/docs/src/components/SectionHeader.tsx +++ b/docs/src/components/SectionHeader.tsx @@ -96,7 +96,7 @@ const StyledSectionHeaderH2 = styled(StyledSectionHeader)` interface SectionHeaderProps { level: any; title: string; - subtitle?: string; + subtitle?: string | Element | React.ReactNode; dark?: boolean; } diff --git a/docs/src/pages/community.tsx b/docs/src/pages/community.tsx index 72b4be2821b..597f74f1231 100644 --- a/docs/src/pages/community.tsx +++ b/docs/src/pages/community.tsx @@ -217,7 +217,6 @@ const Community = () => { } description={
{description}
} - role="group" aria-label="Community link" />