glimmerjs / glimmer-api-docs

API documentation viewer
https://glimmerjs.com/api/
8 stars 9 forks source link

Fix the service worker #28

Open GavinJoyce opened 6 years ago

GavinJoyce commented 6 years ago

TODO:


It seems that the current service worker can result in empty docs pages for some people. Here's what I see on https://glimmerjs.com/api/:

screen shot 2017-11-05 at 07 50 01

Also reported here:

screen shot 2017-11-05 at 07 42 34
marcoow commented 6 years ago

I just realized we're not fingerprinting assets so that https://github.com/glimmerjs/glimmer-api-docs/blob/master/workers/service.ts#L42 makes no sense of course 🤦‍♂️

I guess we should be fingerprinting though or is there any particular reason not to do it?

rwjblue commented 6 years ago

Ya, I think we should add fingerprinting back in. It should be as simple as adding broccoli-asset-rev I think?

kmoe commented 6 years ago

I also get an empty docs page:

good_start

Please could you let me know if there is a workaround or some plaintext version of the API docs available. docs-source/main.json is quite hard to read.

marcoow commented 6 years ago

The fix for now is to delete the service worker manually (or use Safari ;) )

t-sauer commented 6 years ago

Even after deleting the service worker (or when using Safari) it currently doesn't work since one of the broken main.json files is deployed.

kmoe commented 6 years ago

Likewise, the service worker makes no difference (and I don't have Safari as I'm on Linux). I would recommend making your API docs app as simple as possible (render the JSON to HTML, serve it) to ensure high availability of essential developer content.

marcoow commented 6 years ago

I agree with you @kmoe but I think the idea was/is to use the API docs as a show case for Glimmer which makes some sense as well (although it has massively backfired already - mostly my fault messing up the service worker).