Webpack.js.org: Link to the doc site from existing docs

[dmitriid]

The full summary is here: https://github.com/webpack/webpack/issues/1545#issuecomment-255618736 and perhaps here: https://github.com/webpack/webpack/issues/3275

tl;dr version: People would love to learn more about webpack 2 (even if it's a WIP) and help with improving documentation etc. However: there is absolutely no way to discover that the new doc site exists or that it needs help.

Request:

• update webpack's README with a link to the new documentation site. Something like

If you're looking for webpack 2 documentation, go here (work in progress)

• on the front page of webpack 1.x documentation put the same info:

If you're looking for webpack 2 documentation, go here (work in progress)

• on the front page of 2.x documentation clearly state the version the site refers to as in

Documentation site for Webpack 2 (WIP, beta, whatever)

[dmitriid]

Additionall request: add a link to the webpack blog (in the old website, in the new website, in the README)

I only learned about the blog's existence today via a comment in an issue somewhere

[skipjack]

There is a link to the blog in the fixed Sidecar on the right, although maybe it's not prominent enough:

In order -

Github icon links to mains repo
Gitter icon opens webpack room in gitter as an overlay
Medium icon links to blog
SO icon links to webpack tag on stack overflow

[dmitriid]

I'd say it's completely undiscoverable :) This entire block looks just like some social media icons for sharing or something :)

[skipjack]

@dmitriid any ideas for a more prominent location/design? Maybe moving these to the header and footer, or somehow tweaking the existing layout to make them more discoverable?

[dmitriid]

It's quite common to have the link to the blog in the header, to the right of all other links. Since you'll probably want to include the other links as well, I think it would be enough to move the icons there.

That is, you could end the header menu with the icons for Github, Medium, SO.

And add a plain text "Blog", "Github", "Stackoverflow" in the footer as well

[TheLarkInn]

@dmitriid @bebraw we now have both docs site linked from our core repo? I'd like to get a check list of items that fulfills this issue so we can get it done

[dmitriid]

I think the checklist in my original post is quite ok:

• [x] update webpack's README with a link to the new documentation
• [x] on the front page of webpack 1.x documentation put the same info
• [ ] on the front page of 2.x documentation clearly state the version the site refers to (as in "Documentation site for Webpack 2 (WIP)"

Because most people searching for webpack (any version) will end up on webpack.github.io.

It would also be nice to:

• [ ] put a link to the blog in all these places as well (something like "For latest news and updates follow our blog" (new doc site has the link already. Other than that link the blog is undiscoverable)

[TheLarkInn]

Landing page updated.

[dmitriid]

WOOOHOOO. This is awesome!

[TheLarkInn]

Deployed docs splash page header changes to call out v2.

[TheLarkInn]

Eventually we are going to migrate away from the old site if possible completely down the road and all documentation will live in this state. I'm not sure if we have a way besides heavily calling out webpack 2 docs being somewhere else.

@bebraw @skipjack Where would be the most appropriate place to call out that webpack.js.org is v2 docs only.

[TheLarkInn]

put a link to the blog in all these places as well (something like "For latest news and updates follow our blog" (new doc site has the link already. Other than that link the blog is undiscoverable)

@dmitriid would you mind submitting a separate issue for this. I agree that it is nice to have and shouldn't block our milestone. Then we can discuss the design etc. there.

[SpaceK33z]

@TheLarkInn awesome work. We could do it like vue.js and put it at the top of the sidebar. For now maybe put it there as static text, and later we can make a fancy selector. An alternative would be to put it just right of the logo, but I feel like that would be less "clean".

[bebraw]

@bebraw @skipjack Where would be the most appropriate place to call out that webpack.js.org is v2 docs only.

Would it work to have "2" right next to webpack? That's the simplest solution I can think of. There can also be a big fat disclaimer somewhere.

[SpaceK33z]

@bebraw, what do you think of doing it like this?

It has the advantage that we can later easily turn it into a selector.

[bebraw]

Looks good to me.

[TheLarkInn]

Getting a PR here soon for that. We will need a bit more work to display it on mobile but I think this could suffice.