Problem/Motivation

Currently, people looking for ways to contribute documentation to the Drupal project.

Remaining tasks

(reviews needed, tests to be written or run, documentation to be written, etc.)

Proposed resolution

I propose the following “I want heading” to be added to /community:


Add the content you want to be added to the website, according to the format described below. You should refer to the Content Guidelines for Documentation for language style and #3003061: [META] Description of page layout and requirements for headings for a wider understanding of final layout.

I want to contribute documentation to the Drupal Project

All of the documentation that makes the Drupal Project is freely contributed by people all around the World, just like you. Contributing to any large project requires collaboration between project members and the people and processes that make that a productive and enjoyable experience.

The following groups are actively engaged, helping new contributors to join the project:

Drupal documentation is constantly evolving. You can learn about gettting started with contribution to the documentation at:

As collaboration on contribution to Drupal is such an integral part of the community, there are many ways to communicate with others doing the same and to learn from them:

  • Instant messaging tools, such as Slack (sign up, then join channel(s) #documentation ) and DrupalChat.me (sign up, then join channel(s) #general).
  • Many meet-ups and Drupal events, like DrupalCamps and DrupalCons, have "Contribution Days" or "Sprints". You can find events planned near you by looking at http://drupical.com

This section is still under discussion - you can help here: #3006698: Add Section Heading “contribute documentation to the Drupal Project”

Comments

rachel_norfolk created an issue. See original summary.

jhodgdon’s picture

Issue summary: View changes

Minor editing.

As in the Contributing Code section, I don't think linking to the Getting Involved Guide is useful. I think it should be incorporated into this page in "I want to..." format. This is much better.

Also formatted the final paragraph as a bullet list.

bramdriesen’s picture

Status: Needs review » Needs work

Maybe silly, but we seem to reference on almost every single section to all the IRC channels (slack, drupalchat, IRC etc).

Wouldn't it be better to create a "I want to get in contact with the community" section which we can then reference on all the other sections. This way we don't have the duplication, and if we ever need to add/remove/update an IRC, it's just one place instead of almost every other section.

EDIT: At least all the general IRC pointers could go to that new section. I guess there are still some "edge cases" where you can reference to specific IRC channels/pages.

rachel_norfolk’s picture

The idea is that each section contains links to the canonical info on the subject, the groups who make decisions in this area, where to post questions and where to communicate with like-minded people on IM and in-person. With things like IM, the plan is to link to the actual channels that are relevant, rather than saying "Slack exists, good luck!"

Admittedly, it would be nice if Slack let us link directly to a channel, like Drupalchat.me does...

bramdriesen’s picture

Hmm yeah good point, but I still think the "general pointers" to e.g. slack could be consolidated into one section. + it might add value to have the section on its own.

rachel_norfolk’s picture

Maybe a new heading, "Where do I meet the Drupal Community?"

That could include the various methods of signing up to Slack etc, then we don't need to mention that in each section below? I could live with that, so long as the sections continue to say where on each platform to find the right channels etc

bramdriesen’s picture

Yes that's the idea :) if everyone can live with that I think it's a great option.

jhodgdon’s picture

I don't think that is a good idea, actually. I think it is better if each section is self-contained.

We already have a page that tells how to sign up for Slack, drupal.org/slack (or at least it should tell that). We should be pointing people there (which we are in each section), and then in each section saying which channels to use. I think the sections are good as they are.

bramdriesen’s picture

The idea is to still keep the pointers in every section. But that there is also one consolidated section with all the references to the different channels we use to communicate with each other.

rachel_norfolk’s picture

Okay - so if the text in a section said something like below...

  • If you have questions, you can benefit for participating in Drupal instant messaging tools, such as Slack and then ask for help in #documentation) or DrupalChat.me and ask your questions in channel #general).
  • Would that work? We can then follow that pattern throughout.

    jhodgdon’s picture

    #9 sounds very confusing, because the header will be similar to other sections about finding the community.

    I kind of like #10, but I am not sure why/if it's better than what we have in these sections now, which already follows a pattern?

    We should also make sure that the Slack and Drupal Chat me pages have sufficient information for people to figure out how to use them... I haven't looked at them recently.

    rachel_norfolk’s picture

    #10 will certainly reduce the maintenance overhead as sign up process to Slack and Drupalchat can be handled in a single location. I know that the Drupalchat signup process will definitely change once oAuth is ready.

    jhodgdon’s picture

    I created #3008663: Standardize items about Slack and DrupalChat to discuss how we should refer to chat stuff, so we can standardize and discuss it in one place.

    rachel_norfolk’s picture

    Issue summary: View changes
    Status: Needs work » Needs review

    standard IM text added

    Dan_Lind’s picture

    If both the "contribute code" and "contribute documentation" sections link to the Getting Involved guide, it might be better to link to the specific sections of the guide that are useful for contributing code in the code section and vice versa. Other than that, I think the text is good.

    jhodgdon’s picture

    Status: Needs review » Needs work

    Yes, I said that in #2 :) I think we need to set this section to Needs Work. By the way #3005071: Add Section Heading “contribute code to the Drupal Project” does not link to Getting Involved. We need to update this section in the same way.

    rachel_norfolk’s picture

    Issue summary: View changes

    Okay, I'd like to have at least one on the page that is still in need of love so maybe this it it? :-)

    Updating for accordion and copying text, but adding a link back to this issue...

    tatarbj’s picture

    rachel_norfolk’s picture

    Component: Content » Community Content
    Status: Needs work » Postponed

    I think changes that are still required here are mainly changes to the target of links to the Getting Involved Guide and we are about to change it! Setting to Postponed until we are more sure of URIs

    jhodgdon’s picture

    Status: Postponed » Closed (duplicate)
    Related issues: +#3109667: Create/migrate content for Contribution Area: Contribute to Documentation

    We now have
    https://www.drupal.org/community/contributor-guide/contribution-areas/do...

    Marking this as a duplicate of the issue for creating content for that area.