Introduce an open Documentation policy


#1

I think the project would benefit from having an open policy on getting documentation or Guides added or amended, similar to what the Rails team implemented five years ago.

The current process of submitting documentation via pull requests the the Ember Website repo takes too long, requires too much effort on the part of the documenter to chase up someone on the core team to get the PR accepted or any kind of feedback.

The danger is that documentation could be submitted that has errors or is factually incorrect or inconsistent, but perhaps it’s better to have documentation that is 60% correct, say, than non-existant?

Anyway, the rails-doc project saw some good uplift after implementing their curent policy so I thought it would be worth starting the discussion.


#2

This is a good idea. I can’t promise that we’ll implement it, but it certainly merits further discussion.


#3

I would be very much in favour of a project like this. I think it has several key benefits:

  • Reduces the barrier to contribution
  • Frees up the Core Team
  • Allows documentation ‘champions’ to evolve organically
  • Guards against stale information (i.e. more likely to be kept up-to-date)
  • Encourages contribution at the point of inaccuracy (e.g. fix while going through a guide)
  • Promotes community responsibility
  • Exhibits loose coupling

#4

I actually disagree with this. Documentation that seems like it’s correct but isn’t causes far more damage, because it stops you from seeking the correct answer. I’m not happy when people can’t find answers in the documentation, but it’s better than wrong answers.

Really? I just reviewed the backlog of pull requests and I don’t see anything egregiously out-of-date (wish I could say the same thing for Ember Data). Given that this is an all-volunteer staff, a lead time of a week or two to properly review doesn’t seem too bad, although there’s room for improvement.

We’ve tried similar strategies in the past and in general the quality was uneven and, in my opinion, reflected poorly on the project. As a compromise, how would you feel about expanding the documentation team? I am more than happy to open up triage to a larger team, although I would prefer they be vetted instead of implementing a “one PR accepted = commit bit” policy.


#5

That’s fair, I just wanted to start a discussion around it at least.

I guess I was referring to much to my own experience on trying to get feedback on documentation I’d written for the BasicAdapter. I know everyone’s busy, so I don’t like to pester too much, but at the same time, an open PR for documentation keeps a thread tied up in my head on managing tasks.

1,000x yes :smile: Would be great if this could include access to the Campfire (or a new documentation only Campfire) so that when documentation is being written queries can be answered quickly.

Onwards!


#6

This is one of my bug-bares too at the moment.