You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ma...@apache.org on 2020/10/06 20:52:06 UTC
[incubator-superset] branch master updated: fix: 📜 `/docs/api` won't render (#11168)
This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-superset.git
The following commit(s) were added to refs/heads/master by this push:
new 071c81f fix: 📜 `/docs/api` won't render (#11168)
071c81f is described below
commit 071c81f82eedb80c1119cafe9ea16e311f22cce2
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Tue Oct 6 13:51:40 2020 -0700
fix: 📜 `/docs/api` won't render (#11168)
* fix: docs/api won't render
fix: docs/api won't render
It's unclear to me exactly why, but docz is flimsy with the way
things are named and runs into odd collision and error messages.
Somehow renaming the route seem to help. Jut rolling with it after many
`gatsby clean`
* kill paths-ignore on github-actions
* trigger
---
.github/workflows/superset-e2e.yml | 8 +-------
.github/workflows/superset-frontend.yml | 8 +-------
.github/workflows/superset-python.yml | 8 +-------
.github/workflows/test-hive.yml | 8 +-------
.github/workflows/test-presto.yml | 8 +-------
docs/src/components/AnchorNavigator.tsx | 2 +-
docs/src/components/MainMenu.tsx | 4 ++--
docs/src/pages/docs/api.mdx | 4 ++--
8 files changed, 10 insertions(+), 40 deletions(-)
diff --git a/.github/workflows/superset-e2e.yml b/.github/workflows/superset-e2e.yml
index f634e15..dfa6910 100644
--- a/.github/workflows/superset-e2e.yml
+++ b/.github/workflows/superset-e2e.yml
@@ -1,12 +1,6 @@
name: E2E
-on:
- push:
- paths-ignore:
- - 'docs/**'
- pull_request:
- paths-ignore:
- - 'docs/**'
+on: [push, pull_request]
jobs:
Cypress:
diff --git a/.github/workflows/superset-frontend.yml b/.github/workflows/superset-frontend.yml
index 0f0b5db..8d10e0b 100644
--- a/.github/workflows/superset-frontend.yml
+++ b/.github/workflows/superset-frontend.yml
@@ -1,12 +1,6 @@
name: Frontend
-on:
- push:
- paths-ignore:
- - 'docs/**'
- pull_request:
- paths-ignore:
- - 'docs/**'
+on: [push, pull_request]
jobs:
build:
diff --git a/.github/workflows/superset-python.yml b/.github/workflows/superset-python.yml
index 5da41d9..6bfe377 100644
--- a/.github/workflows/superset-python.yml
+++ b/.github/workflows/superset-python.yml
@@ -1,13 +1,7 @@
# Python unit tests
name: Python
-on:
- push:
- paths-ignore:
- - 'docs/**'
- pull_request:
- paths-ignore:
- - 'docs/**'
+on: [push, pull_request]
jobs:
lint:
diff --git a/.github/workflows/test-hive.yml b/.github/workflows/test-hive.yml
index b372be4..2571f4a 100644
--- a/.github/workflows/test-hive.yml
+++ b/.github/workflows/test-hive.yml
@@ -1,12 +1,6 @@
name: Hive
-on:
- push:
- paths-ignore:
- - 'docs/**'
- pull_request:
- paths-ignore:
- - 'docs/**'
+on: [push, pull_request]
jobs:
test-postgres-hive:
diff --git a/.github/workflows/test-presto.yml b/.github/workflows/test-presto.yml
index 360026b..14ac0a8 100644
--- a/.github/workflows/test-presto.yml
+++ b/.github/workflows/test-presto.yml
@@ -1,12 +1,6 @@
name: Presto
-on:
- push:
- paths-ignore:
- - 'docs/**'
- pull_request:
- paths-ignore:
- - 'docs/**'
+on: [push, pull_request]
jobs:
test-postgres-presto:
diff --git a/docs/src/components/AnchorNavigator.tsx b/docs/src/components/AnchorNavigator.tsx
index 4737109..cda6359 100644
--- a/docs/src/components/AnchorNavigator.tsx
+++ b/docs/src/components/AnchorNavigator.tsx
@@ -52,7 +52,7 @@ const HeaderNav = () => {
<div css={anchorNavStyle}>
<Anchor>
{headings.map((e) => (
- <Link href={`#${e.slug}`} title={e.value} />
+ <Link key={e.slug} href={`#${e.slug}`} title={e.value} />
))}
</Anchor>
</div>
diff --git a/docs/src/components/MainMenu.tsx b/docs/src/components/MainMenu.tsx
index 4482fe5..dd4631a 100644
--- a/docs/src/components/MainMenu.tsx
+++ b/docs/src/components/MainMenu.tsx
@@ -133,9 +133,9 @@ export default class MainMenu extends React.Component {
const { visible } = this.state;
return (
<Layout.Header css={headerStyle}>
- <Link to="https://superset.incubator.apache.org">
+ <a href="https://superset.incubator.apache.org">
<img height="50" css={logoStyle} src={logoSvg} alt="logo" />
- </Link>
+ </a>
<MenuItems toggleDrawer={this.toggleDrawer} mode="horizontal" />
<Drawer
title="Menu"
diff --git a/docs/src/pages/docs/api.mdx b/docs/src/pages/docs/api.mdx
index 724ddf1..c0845ab 100644
--- a/docs/src/pages/docs/api.mdx
+++ b/docs/src/pages/docs/api.mdx
@@ -1,7 +1,7 @@
---
name: API
title: API
-route: /docs/api
+route: /docs/rest-api
---
## API
@@ -17,6 +17,7 @@ documented here. The docs bellow are generated using
[Swagger React UI](https://www.npmjs.com/package/swagger-ui-react).
<Alert
+ type="info"
message={
<div>
<strong>NOTE! </strong>
@@ -25,7 +26,6 @@ documented here. The docs bellow are generated using
at <strong>/swagger/v1</strong> (if enabled)
</div>
}
- type="info"
/>
<br /><br /><hr />