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 the service worker #28

Open
1 of 2 tasks
GavinJoyce opened this issue Nov 5, 2017 · 7 comments · May be fixed by #29
Open
1 of 2 tasks

Fix the service worker #28

GavinJoyce opened this issue Nov 5, 2017 · 7 comments · May be fixed by #29

Comments

@GavinJoyce
Copy link
Contributor

GavinJoyce commented Nov 5, 2017

TODO:

  • Temporarily disable the service worker (as being able to access the docs is more important than raw load time): disable service worker #27
  • Fix the service worker (perhaps we need some ability to bust the cache?)

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
Copy link
Member

marcoow commented Nov 6, 2017

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
Copy link
Member

rwjblue commented Nov 6, 2017

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

@kmoe
Copy link

kmoe commented Nov 8, 2017

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
Copy link
Member

marcoow commented Nov 8, 2017

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

@t-sauer
Copy link
Contributor

t-sauer commented Nov 8, 2017

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
Copy link

kmoe commented Nov 8, 2017

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
Copy link
Member

marcoow commented Nov 8, 2017

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).

@marcoow marcoow linked a pull request Nov 8, 2017 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants
@marcoow @GavinJoyce @rwjblue @t-sauer @kmoe and others