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.

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

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

Merged
merged 3 commits into from
Oct 6, 2020
Merged

Conversation

mistercrunch
Copy link
Member

@mistercrunch mistercrunch commented Oct 6, 2020

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

Also fixing a few warnings here while I'm at it, and turning off the github-actions path-ignore that doesn't work for us in the current state.

    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`
@@ -1,7 +1,7 @@
---
name: API
title: API
route: /docs/api
route: /docs/rest-api
Copy link
Member Author

@mistercrunch mistercrunch Oct 6, 2020

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.

@pull-request-size pull-request-size bot added size/M and removed size/S labels Oct 6, 2020
@mistercrunch mistercrunch changed the title fix: docs/api won't render fix: 📜 /docs/api won't render Oct 6, 2020
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.

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

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.

This should become:
on: [push, pull_request]

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]

- '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]

Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

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

The fix LGTM, but the changes to the actions as written here will completely disable them for ALL pull requests. I noted the prior state of these files so you can paste in the correct configuration to undo my mistake (sorry you got caught up in it!)

@codecov-io
Copy link

codecov-io commented Oct 6, 2020

Codecov Report

❗ No coverage uploaded for pull request base (master@152315d). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master   #11168   +/-   ##
=========================================
  Coverage          ?   61.70%           
=========================================
  Files             ?      828           
  Lines             ?    39116           
  Branches          ?     3688           
=========================================
  Hits              ?    24137           
  Misses            ?    14798           
  Partials          ?      181           
Flag Coverage Δ
#javascript 62.30% <ø> (?)
#python 61.34% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 152315d...796ffcb. Read the comment docs.

Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

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

LGTM!

@mistercrunch mistercrunch merged commit 071c81f into apache:master Oct 6, 2020
@mistercrunch mistercrunch deleted the fix_docs branch October 6, 2020 20:51
auxten pushed a commit to auxten/incubator-superset that referenced this pull request Nov 20, 2020
* 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
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.0.0 labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 1.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants