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

Update docs for v5.0 #2764

Closed
phated opened this issue Mar 29, 2024 · 10 comments
Closed

Update docs for v5.0 #2764

phated opened this issue Mar 29, 2024 · 10 comments
Assignees

Comments

@phated
Copy link
Member

phated commented Mar 29, 2024

We need to update the docs (and publish to website) for the v5 release.

@phated phated added this to post-v5 Mar 29, 2024
@phated phated moved this to Todo in post-v5 Mar 29, 2024
@phated
Copy link
Member Author

phated commented Mar 29, 2024

A couple things I noticed during skimming:

  • Need to remove the "ordered globs" docs
  • Need to update configuration options to vinyl-fs functions

@phated phated pinned this issue Mar 29, 2024
@gulpjs gulpjs deleted a comment from Fa-haxiki Mar 29, 2024
@yocontra
Copy link
Member

yocontra commented Apr 6, 2024

Encoding option added: https://github.com/gulpjs/gulp/blob/master/docs/api/src.md#options

@phated
Copy link
Member Author

phated commented Apr 8, 2024

"Explaining Globs" docs have been updated and a section added with an example for ordered globs using ordered-read-stream: https://github.com/gulpjs/gulp/blob/master/docs/getting-started/6-explaining-globs.md#ordered-globs

@Sebazzz

This comment has been minimized.

@yocontra

This comment has been minimized.

@Sebazzz

This comment has been minimized.

@yocontra

This comment has been minimized.

timvandermeij added a commit to timvandermeij/pdf.js that referenced this issue May 31, 2024
This is a major version bump, and the changelog at
https://github.com/gulpjs/gulp/releases/tag/v5.0.0 indicates one
breaking change that impacts us, namely that streams are now by default
interpreted/transformed to UTF-8 encoding. This breaks `gulp.src` calls
that work on binary files such as images or CMaps, but is fortunately
easy to fix for us by disabling re-encoding for all `gulp.src` calls
(see gulpjs/gulp#2764 (comment)
for more information). This restores the previous behavior of copying
the files as-is without Gulp performing any transformations to it, which
is what we want because Gulp is only used for bundling and we make sure
that the source files have the right encoding.
timvandermeij added a commit to timvandermeij/pdf.js that referenced this issue May 31, 2024
This is a major version bump, and the changelog at
https://github.com/gulpjs/gulp/releases/tag/v5.0.0 indicates one
breaking change that impacts us, namely that streams are now by default
interpreted/transformed to UTF-8 encoding. This breaks `gulp.src` calls
that work on binary files such as images or CMaps, but is fortunately
easy to fix for us by disabling re-encoding for all `gulp.src` calls
(see gulpjs/gulp#2764 (comment)
for more information). This restores the previous behavior of copying
the files as-is without Gulp performing any transformations to it, which
is what we want because Gulp is only used for bundling and we make sure
that the source files have the right encoding.
@stamminator

This comment has been minimized.

@mrleblanc101

This comment has been minimized.

@phated
Copy link
Member Author

phated commented Aug 19, 2024

The markdown docs have been updated and redeployed to the website so I'm going to close this.

As the major v4 release didn't contain a migration guide, we're not considering it required for v5 either. If anyone from the community wants to contribute further docs, like a migration guide, we're happy to review PRs!

@gulpjs gulpjs locked and limited conversation to collaborators Aug 19, 2024
@phated phated closed this as completed Aug 19, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in post-v5 Aug 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Status: Done
Development

No branches or pull requests

6 participants