search

backdrop-ops / backdropcms.org

Issue tracker for the BackdropCMS.org website
https://backdropcms.org
25 stars 20 forks source link

Create a "Contributors" guide on BackdropCMS.org #486

Open stpaultim opened 5 years ago

stpaultim commented 5 years ago

Problem

For new users it can be difficult and confusing to figure out how to contribute to BackdropCMS. For many people there is an intimidation factor and fear of doing things wrong that prevents them from contributing a PR, commenting on an issue, or reviewing/testing a PR. The more detailed and explicit we can be about how to contribute, the more likely people are to become active in the community.

Inspired by this request: https://forum.backdropcms.org/forum/how-do-i-test-pull-request

Proposed Solution

Create a "contributors guide" on BackdropCMS org similar to the "Getting Involved Guide" on Drupal.org (https://www.drupal.org/getting-involved-guide)

I recommend focusing on the basics of how the community works and something akin to the contributor tasks sections on D.O. https://www.drupal.org/contributor-tasks

I am willing to take some initiative on helping organize and write these guides. I would ask for input and feedback on tasks that I don't understand well.

But, I'd like some feedback on the idea before I get started. Also, any historical information about whether or not there has been discussion of this before.

Related Issues:

https://github.com/backdrop-ops/backdropcms.org/issues/485

jenlampton commented 5 years ago

This would be great @stpaultim but let's keep it code free. For docs about code stuff, let's put those on api.backdropcms.org (and we can link back and forth from one site to another, wherever necessary).

stpaultim commented 5 years ago

Agreed. This contributor guide would not be about code. It's about helping people contribute whatever their skill level. I just looked at how existing documentation is structured on BackdropCMS.org and I'm seeing two main sections.

  1. Backdrop CMS Handbook 1.1 About Backdrop CMS 1.2 Backdrop Contributors Guide (PROPOSED) 1.3 Backdrop Developer notes
  2. Backdrop CMS User Guide

I wondered if the Contributor guides should be a part of the CMS Handbook or if it should be a section on it's own. I'm inclined to start with it as a section of the CMS Handbook (see above).

@klonos also just raised the question of whether or not there should be a listing for Contributors on the resources page.

My plan, pending any feedback to the contrary, it to work up a couple of pages in DRAFT mode for now and then get some feedback before publishing anything. Does this make sense?

jenlampton commented 5 years ago

Sounds great!

On Thu, Dec 27, 2018, 3:21 PM Tim Erickson <notifications@github.com wrote:

Agreed. This contributor guide would not be about code. It's about helping people contribute whatever their skill level. I just looked at how existing documentation is structured on BackdropCMS.org and I'm seeing two main sections.

  1. Backdrop CMS Handbook 1.1 About Backdrop CMS https://backdropcms.org/about 1.2 Backdrop Contributors Guide (PROPOSED) 1.3 Backdrop Developer notes https://backdropcms.org/developers
  2. Backdrop CMS User Guide https://backdropcms.org/user-guide

I wondered if the Contributor guides should be a part of the CMS Handbook or if it should be a section on it's own. I'm inclined to start with it as a section of the CMS Handbook (see above).

@klonos https://github.com/klonos also just raised the question of whether or not there should be a listing for Contributors on the resources https://backdropcms.org/support/resources page.

My plan, pending any feedback to the contrary, it to work up a couple of pages in DRAFT mode for now and then get some feedback before publishing anything. Does this make sense?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/backdrop-ops/backdropcms.org/issues/486#issuecomment-450251299, or mute the thread https://github.com/notifications/unsubscribe-auth/AAYSR7Mc590SOq8tBXQdIGUemIRpWuI2ks5u9VXtgaJpZM4ZKXQg .

klonos commented 5 years ago

Yes, please go ahead and create those drafts @stpaultim. Please ping me on Gitter when you need a review.

stpaultim commented 3 years ago

I went ahead and started a contributors guide. It may come in handy for OSD (Open Source Day 2020) and/or it might be a great chance to get help drafting some additional content.

Any OSD participants, please feel free to comment on what should be included or jump in and help us write some copy.

jenlampton commented 3 years ago

One note that anything high-level can go on the main site, but as soon as we start talking about writing code or filing PRs that needs to be a page on the API site. (We should feel free to cross-link between them as much as necessary, though!)