Linking to this guide from site/docs

Question

Linking to this guide from site/docs

Closed this issue 10 years ago · 31 comments

tdd commented 10 years ago

Hey guys, so what should we do before the official announcement of this guide, to make sure it's easily discoverable?

Links from the site

Main navbar?
Replace/complement README link in the home's Getting started section?
Complement the contents of the home's Documentation section?
Link to chapter 1 from the bottom of the home's "Why Brunch and not…" section?

Links from the docs

Link from the top of docs/README.md?
What else?

paulmillr commented 10 years ago

Done.

paulmillr commented 10 years ago

woah

Answer 1 · 2015-04-04T17:39:28.000Z

BTW this takes over that particular task list / reflexion from the last of #1.

Also, I seem to have commit rights to brunch.github.io, so I can handle whatever site tasks we agree on. On the other hand, I don't have commit rights on brunch (rightly so, for now…), so docs tasks are yours, guys 😉

Answer 2 · 2015-04-06T15:05:52.000Z

navbar — yes.
readme — yes
yes
yes

Answer 3 · 2015-04-06T21:04:57.000Z

OK, so I'll create an in-repo PR for brunch.github.io with these 4 items. And a fork-based PR for the docs item.

Answer 4 · 2015-04-07T06:35:10.000Z

Hey guys,

So brunch/brunch#952 contains the last item of work for this. The rest (the Brunch site) was done and published.

Answer 5 · 2015-04-07T06:36:37.000Z

By the way sorry about auto-publishing the links: I thought grunt publish just prepped a branch, and by the time I realized it didn't it was too late 😒

Answer 6 · 2015-04-07T13:26:38.000Z

Sweet! So it's all in! Should we get to announcement? I figure the following avenues are nice:

Stuff I will do

Tag the current guide as v1.7.20, so 1.7.x users can easily get "their" version if they can't upgrade for some reason.
Once 1.8 is out, carefully review the changelog and adjust any relevant part of the guide.
Announce in on my own Twitter feeds (porteneuve, jsattitude, nodeschoolparis), using scheduled tweet campaigns (FR/EN on porteneuve, FR-only on the others)
Put a block at the top of the original, French article saying future updates and extra contents are to be looked for in the guide (and linking, of course)
Post on Hackernews at a carefully chosen time of day
Post on Reddit (/r/javascript, /r/nodejs) at a carefully chosen time of day
Submit this to DailyJS
Submit this to JSWeekly
Submit this to HTML5Weekly
Submit this to NodeWeekly

Stuff you can do

Announce a couple times (scheduled?) on Brunch's twitter account / your accounts?
What else…?

Answer 7 · 2015-04-07T15:27:38.000Z

@tdd a quick thing. Can we do the next day after 1.8 release (which would be today)? We can update it just in place, a few important & useful changes.

I'll post it under my twitter account and under brunch account, would retweet with others.

Answer 8 · 2015-04-07T15:28:18.000Z

Also, Hacker News.

Answer 9 · 2015-04-07T15:31:37.000Z

@paulmillr No problem at all, we can even defer that to later this week, as I might be too caught up tonight and tomorrow to have enough time to sift through 1.8 changelog and adjust the guide properly in both languages.

I'll tag the current guide as v1.7.20 to start with, so people can refer to it if need be.

Answer 10 · 2015-04-07T15:32:28.000Z

Oh and by Reddit, I did mean HN 😂

It seems lots of people use this interchangeably, and not being a regular user of either, I find it hard to tell which is which (and which is best for what) 😄

Answer 11 · 2015-04-07T16:18:25.000Z

r/javascript / r/nodejs should work great too!

Answer 12 · 2015-05-27T02:17:10.000Z

Let's do the release for this thing! 1.8 is finally out after all.

Answer 13 · 2015-05-27T06:44:44.000Z

Hey! Yes, it's out, but the guide hasn't been updated yet. I need to dive into the specifics of node_modules integration, mostly. The rest of the updates are tiny.

I'm a bit underwater just now, as my firstborn son arrived 9 days ago 😄 — Will try to work on this before the week is over, though.

Answer 14 · 2015-05-27T09:49:21.000Z

Hey @paulmillr @es128 I've been browsing the source code for node_modules handling, and I'm a bit confused as to how it behaves.

It seems that it only ever watches a module's main/index.js file, and only adds that in the bundle? I fail to see where it gets the other files to bundle in, be it a static filetree traversal, or a dynamic require(…) analysis, a la Browserify or Webpack.

Do we have an up-to-date spec doc somewhere for this? Is this documented anywhere in a comprehensive manner (which this guide would have to do, too)?

Proper node_modules handling, esp. wrt isomorphic JS, is still the main reason people stay away from Brunch in favor of Browserify or Webpack. But from my first dive into it, it seems to me the new handling of node_modules is rather sub-par here. What am I missing?!

Cheers,

Answer 15 · 2015-05-27T15:09:05.000Z

cc @yavorsky

Answer 16 · 2015-05-27T16:40:38.000Z

I think we can release the guide with the bower integration as-is. Node modules still require some polishing and not all packages do support it.

Hey @tdd congratz on your newborn!

Answer 17 · 2015-05-27T17:12:20.000Z

yeah, we should leave npm integration for now. It's actually quite abrasive, I keep getting e-mails and Disqus comments by people who get into all sorts of trouble / confusion using it right now.

We definitely need to huddle sometime soon (Gitter for this repo, maybe?) and hash out:

How it works now, in detail
How it could be improved (and whether it's planned / what the ETA might be)

For now, let me just give a look-over on the guide to make sure it's up to date on other issues (e.g. new server config / code, etc.) then we can fire up the comm'.

Answer 18 · 2015-06-02T07:47:24.000Z

OK so now the guide is updated, let's execute on #4 (comment)

I'm dealing with pending items 1 and 2 (my own feeds, my original FR article) today.
I can also find time to submit info about the guide to the newsletters (DailyJS, xWeekly)
However, I think your (@paulmillr, @es128) posting to HN and Reddit would carry more weight, as creator(s) of the project. If anything, Paul, your karma there's 735 while mine is just 82, having posted there only a couple times.
What would the best times be for such postings? They only let you post a given URL once, so careful scheduling is essential to get it rolling.
Also, can you guys schedule a tweet campaign on the official Brunch account? And perhaps RT these from yours?

Answer 19 · 2015-06-02T20:31:55.000Z

Today's DailyJS: http://dailyjs.com/2015/06/02/wallaby-js-brunch/

Answer 20 · 2015-06-03T09:45:09.000Z

I'll send it to Twitter and HN today. Could someone do it for the reddit?

Answer 21 · 2015-06-05T11:34:11.000Z

Hey Paul,

Have you sent it to HN? Can't find it. Will send to Reddit now.

Answer 22 · 2015-06-05T11:34:37.000Z

Also, Peter C from Xxx Weekly got the message, will investigate and likely write about it.

Answer 23 · 2015-06-05T11:55:42.000Z

/r/javascript : https://www.reddit.com/r/javascript/comments/38nnid/brunch_the_frontend_app_build_tool_has_a_spiffy/
/r/node : it won't let me cross-post there. Perhaps an issue with my brand-new profile?

Answer 24 · 2015-06-05T15:21:35.000Z

@tdd @es128 please upvote it on HN.

Answer 25 · 2015-06-05T15:28:08.000Z

Just did, and spread the word to help!

Answer 26 · 2015-06-05T15:28:25.000Z

You might want to do the same on the Reddit post (linked earlier)

Answer 27 · 2015-06-05T15:36:42.000Z

Except that direct link upvotes don't count 😢

Answer 28 · 2015-06-05T17:57:16.000Z

Congratz everyone, we've made it. Trending on HN for 1.5h.

Answer 29 · 2015-06-05T19:19:38.000Z

Ha! Yeah, RTs by Brendan tend to help. I'm fortunate enough that he follows me, knows me well and respects my work, so sometimes this happens.

Great to see Brunch trending on HN. Barely 4 on Reddit, but hey.