-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
Conversation
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 |
There was a problem hiding this comment.
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: | ||
paths-ignore: | ||
- 'docs/**' | ||
|
There was a problem hiding this comment.
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/**' | ||
|
There was a problem hiding this comment.
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/**' | ||
|
There was a problem hiding this comment.
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/**' |
There was a problem hiding this comment.
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]
There was a problem hiding this 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 Report
@@ Coverage Diff @@
## master #11168 +/- ##
=========================================
Coverage ? 61.70%
=========================================
Files ? 828
Lines ? 39116
Branches ? 3688
=========================================
Hits ? 24137
Misses ? 14798
Partials ? 181
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
* 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
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.