Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: 📜 /docs/api won't render #11168

Merged
merged 3 commits into from
Oct 6, 2020
Merged

fix: 📜 /docs/api won't render #11168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b6075f
fix: docs/api won't render
mistercrunch Oct 6, 2020
dc75862
kill paths-ignore on github-actions
mistercrunch Oct 6, 2020
796ffcb
trigger
mistercrunch Oct 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions .github/workflows/superset-e2e.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
name: E2E

on:
push:
paths-ignore:
- 'docs/**'
pull_request:
paths-ignore:
- 'docs/**'
on: [push, pull_request]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To revert, this should become:
on: [push, pull_request]

jobs:
Cypress:
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/superset-frontend.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
name: Frontend

on:
push:
paths-ignore:
- 'docs/**'
pull_request:
paths-ignore:
- 'docs/**'
on: [push, pull_request]

jobs:
build:
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/superset-python.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# Python unit tests
name: Python

on:
push:
paths-ignore:
- 'docs/**'
pull_request:
paths-ignore:
- 'docs/**'
on: [push, pull_request]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should become:
on: [push, pull_request]

jobs:
lint:
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/test-hive.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
name: Hive

on:
push:
paths-ignore:
- 'docs/**'
pull_request:
paths-ignore:
- 'docs/**'
on: [push, pull_request]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should become on: [push, pull_request]

jobs:
test-postgres-hive:
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/test-presto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
name: Presto

on:
push:
paths-ignore:
- 'docs/**'
pull_request:
paths-ignore:
- 'docs/**'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should become on: [push, pull_request]

on: [push, pull_request]

jobs:
test-postgres-presto:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/components/AnchorNavigator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions docs/src/components/MainMenu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/docs/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: API
title: API
route: /docs/api
route: /docs/rest-api
Copy link
Member Author

@mistercrunch mistercrunch Oct 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the hack/workaround, I was getting collision warnings on /docs/api vs /docs/api/, page wouldn't render (though in the past it did). This one line change plus a gastby clear / restart seem to fix it all.

---
## API

Expand All @@ -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>
Expand All @@ -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 />
Expand Down