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

🐛 Bug: https://mochajs.org/api is now a 404 #5217

Closed
4 tasks done
JoshuaKGoldberg opened this issue Sep 27, 2024 · 4 comments · Fixed by #5240
Closed
4 tasks done

🐛 Bug: https://mochajs.org/api is now a 404 #5217

JoshuaKGoldberg opened this issue Sep 27, 2024 · 4 comments · Fixed by #5240
Assignees
Labels
core-team issues which must be handled by Mocha's core team type: bug a defect, confirmed by a maintainer

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Sep 27, 2024

Bug Report Checklist

  • I have read and agree to Mocha's Code of Conduct and Contributing Guidelines
  • I have searched for related issues and issues with the faq label, but none matched my issue.
  • I have 'smoke tested' the code to be tested by running it outside the real test suite to get a better sense of whether the problem is in the code under test, my usage of Mocha, or Mocha itself.
  • I want to provide a PR to resolve this

Expected

https://mochajs.org/api should exist. It's supposed to be a real website with the API docs for Mocha. Instead, right now it's the Netlify "Page Not Found" default.

Actual

We broke https://mochajs.org/api. 😬 It's supposed to be a real website with the API docs for Mocha. Instead, right now it's the Netlify "Page Not Found" default.

Minimal, Reproducible Example

Visit https://mochajs.org/api

Versions

n/a

Additional Info

Back in #5027, we noted:

We don't intend to overhaul any currently-useful resources such as https://mochajs.org/ or https://github.com/mochajs/mocha/wiki. Though, we will happily accept issue reports if those resources need improvement.

That was before we had to deal with the ancient tech behind the website. It's a lot of old stuff that hasn't been kept up-to-date, such as https://github.com/mochajs/mocha-docdash. #5207 tracks overhauling the website.

In the meantime, we really should fix the API docs. A workaround until then can be to visit it on the wayback machine (😬): https://web.archive.org/web/20240000000000*/https://mochajs.org/api -> https://web.archive.org/web/20240715030741/https://mochajs.org/api. Which doesn't seem to be preserving page styles. Lovely. https://github.com/mochajs/mocha/blob/main/docs/API.md is perhaps a better workaround for now.

@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Mocha can use your help with this one! type: bug a defect, confirmed by a maintainer labels Sep 27, 2024
@Nikshinde7
Copy link

Hey I would love to contribute to this! Can you elaborate more on what exactly is needed here?

@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Oct 30, 2024
@JoshuaKGoldberg JoshuaKGoldberg added core-team issues which must be handled by Mocha's core team status: in triage a maintainer should (re-)triage (review) this issue and removed status: accepting prs Mocha can use your help with this one! status: in triage a maintainer should (re-)triage (review) this issue labels Oct 30, 2024
@JoshuaKGoldberg
Copy link
Member Author

Heya - I'm going to just overhaul the website all-up. So this is going to be a subset of #5207. Thanks though!

@JoshuaKGoldberg
Copy link
Member Author

JoshuaKGoldberg commented Oct 30, 2024

Hmm. #5240 fixed the site locally for me, but https://mochacanary.netlify.app/api and https://mochajs.org/api are still 404s... needs more investigation.

Looking through the Netlify deployments Deploy file browser for them, the api/ directory is still not generating .html files.

@JoshuaKGoldberg
Copy link
Member Author

Aha! It's that we're deploying from the mochajs.org branch. I hadn't updated that branch to the latest. It's updated now and all is well! https://mochajs.org/api is back online. Hooray! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-team issues which must be handled by Mocha's core team type: bug a defect, confirmed by a maintainer
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants