Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Documentation to mention additonal config if using gzip plugin

Open
#23 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start with the repository README or documentation referenced by the issue and check how ember-cli-deploy-gzip configuration is described. Document that users should add the shown ignorePattern for index.json in deploy.js, then review the rendered wording for clarity and completeness.

Written by the indexing model from the issue text.

Description

Love the plugin and the rest of ember-cli-deploy - thank you.

I just ran into an issue where my index.json file was gzipped along with other resources which obviously caused problems.

I don't believe this to be a bug but maybe worth adding to the docs / readme that if using in conjunction with ember-cli-deploy-gzip that you should add the following to your deploy.js file:

gzip: {
  ignorePattern: 'index.json'
}
Dominant language
JavaScript
Stars
17
Forks
11
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ember-cli-deploy/ember-cli-deploy-json-config

All issues in ember-cli-deploy/ember-cli-deploy-json-config

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.