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

Added notice for 4.0.0 vs 3.9.1 documentation #2121

Merged
merged 1 commit into from Feb 7, 2018

Conversation

Lucretiel
Copy link
Contributor

@Lucretiel Lucretiel commented Feb 7, 2018

Because the master branch is the authoritative source of documentation, it can be confusing for developers who have used npm install gulp (or joined a project using gulp 3) that the master branch is for a different major release. This PR adds a simple notification to the API docs, which are linked to from https://gulpjs.com/, that the standard version installed by npm install gulp.

It's worth noting that, while it might be obvious to people familiar with gulp's development, there's no indication that there's a mismatch between master and the current node release anywhere on https://gulpjs.com/, nor on master:docs/API.md, nor in any of the top google search results for "gulpjs documentation".

@phated
Copy link
Member

phated commented Feb 7, 2018

Thanks. Can you also update the website to point to docs at the correct tag? The repo is gulpjs.github.io

@Lucretiel
Copy link
Contributor Author

Oh, I couldn't find the repo at first. Will do.

@yocontra
Copy link
Member

yocontra commented Feb 7, 2018

@Lucretiel Thanks! This should reduce confusion.

@phated phated merged commit 126423a into gulpjs:master Feb 7, 2018
Copy link
Member

@phated phated left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'll change "standard" to "default" when I'm back at a computer.

@Lucretiel
Copy link
Contributor Author

Lucretiel commented Feb 7, 2018 via email

@phated
Copy link
Member

phated commented Feb 7, 2018

Stable specifically means "not prerelease" and 4.0.0 has been released (it's just not default because the docs aren't complete)

@Lucretiel
Copy link
Contributor Author

Lucretiel commented Feb 7, 2018 via email

@kuraga

This comment has been minimized.

@gulpjs gulpjs locked and limited conversation to collaborators Sep 18, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants