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

tweaked and added more pro-documentation points #10

Merged
merged 1 commit into from
Oct 3, 2014

Conversation

svaksha
Copy link
Contributor

@svaksha svaksha commented Oct 3, 2014

Hi @BillMills, cleaned up the article a bit with minor tweaks.

@bkatiemills
Copy link
Member

Hi @svaksha, great, thanks! If you like, as a next step start thinking about some hands-on, interactive exercises people can do to learn about how to produce good documentation (it's a tough problem, I know!) - we want to back up everything we're saying in text format with lessons people can participate in. Thanks again for getting the ball rolling here!

bkatiemills added a commit that referenced this pull request Oct 3, 2014
tweaked and added more pro-documentation points
@bkatiemills bkatiemills merged commit a7f4f4c into mozillascience:master Oct 3, 2014
@codersquid
Copy link

@svaksha if you have an issue for documentation review/creation excercises I would love to point some friends to it. hi @j1mc

@svaksha
Copy link
Contributor Author

svaksha commented Oct 3, 2014

On Fri, Oct 3, 2014 at 5:06 PM, Bill Mills notifications@github.com wrote:

Hi @svaksha, great, thanks! If you like, as a next step start thinking about some hands-on, interactive exercises people can do to learn about how to produce good documentation (it's a tough problem, I know!) - we want to back up everything we're saying in text format with lessons people can participate in. Thanks again for getting the ball rolling here!

Hi @BillMills, Thanks for the merge. Interactive exercises for
documentation is a good idea but dont you think this is better suited
within the 'bc' repo? That way, you will teach and reach a wider
audience and I presume it also fits in with the goal of teaching good
software practices. Just thinking out loud !

On Fri, Oct 3, 2014 at 7:10 PM, Sheila Miguez notifications@github.com wrote:

@svaksha if you have an issue for documentation review/creation excercises I would love to point some friends to it. hi @j1mc

Hi @codersquid, ATM, I have not filed a bug as I will be busy for the
next 4 weeks so I didnt want to keep it pending for that long. The
notes for docs took less time so I pushed those out quickly, so I
wanted to add that if you (or anyone else) want to go ahead please
dont let me be a blocker.

ciao, SVAKSHA ॥ http://about.me/svaksha

@bkatiemills
Copy link
Member

@svaksha I would be delighted if SWC would like to adopt this content, and am happy to help smooth out any bumps there, but we aren't contributing directly to 'bc' because we are trying to reach a more diverse audience than just the bootcamp circuit. I am imagining many of these exercises as being do-able by small study groups or lab teams on their own, without the expense and logistical barriers of having to host an event.

@codersquid see #11 :)

@chendaniely
Copy link

My only suggestion to the prose is to have some link break at some point (80 characters?)
so entire paragraphs aren't all counted as one line.

@codersquid
Copy link

I agree, it makes it hard to see what changed when looking at diffs.

svaksha added a commit to svaksha/codeReview that referenced this pull request Oct 7, 2014
@svaksha svaksha mentioned this pull request Oct 7, 2014
@svaksha
Copy link
Contributor Author

svaksha commented Oct 7, 2014

On Tue, Oct 7, 2014 at 5:00 PM, Bill Mills notifications@github.com wrote:

@svaksha I would be delighted if SWC would like to adopt this content, and am happy to help smooth out any bumps there, but we aren't contributing directly to 'bc' because we are trying to reach a more diverse audience than just the bootcamp circuit. I am imagining many of these exercises as being do-able by small study groups or lab teams on their own, without the expense and logistical barriers of having to host an event.

@codersquid see #11 :)

Hi,
Makes sense to have smaller DIY exercises. Will keep an eye on #11 to
see what others think !
ciao, SVAKSHA ॥ http://about.me/svaksha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants