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.
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.
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 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.