This is a portion of the ongoing reorganization of the Drupal.org handbook.

This is the section of the handbook which contains more general information about CVS: a conceptual introduction to version control, links to CVS guides and resources, lists of CVS GUIs and clients, usage policies for the CVS repository, reference lists of Drupal repositories, branches and tags, CVS quick references, etc.

The distinction between pages that belong here and those that belong in the "Contributing Code" chapter may sometimes turn out to be subtle. The intent is that "Contributing Code" should discuss CVS from a task-based, pragmatic standpoint: it should demonstrate the usage of CVS in the context of accomplishing specific tasks like "creating a new release of my module" or "getting the latest version of the core code and keeping it up to date". More general CVS info, reference materials, and anything which doesn't relate to accomplishing specific Drupal-related tasks should go in this chapter instead.

Suggested outline:

# What is CVS and how Drupal uses it
* Introduction to CVS/RCS
* CVS Usage Policy/Guidelines
* CVS GUIs and clients
* Drupal repositories
* Drupal branches and tags
* Quick reference sheet
* CVS/Project FAQ

Comments

add1sun’s picture

This is essentially the existing CVS section (http://drupal.org/handbook/cvs) without the "Maintaining d.o projects" part, which will be moved into the new "Contributing code" section.

# What is CVS and how Drupal uses it -------- http://drupal.org/handbook/cvs
* Introduction to CVS/RCS -------- http://drupal.org/handbook/cvs/introduction (need to add in some RCS overview to explain what it all means in broader way that people can grok)
* CVS Usage Policy/Guidelines ------- http://drupal.org/node/103704
* CVS GUIs and clients ------- http://drupal.org/handbook/cvs/clients
* Drupal repositories ------- http://drupal.org/repos
* Drupal branches and tags ------- http://drupal.org/handbook/cvs/branches-and-tags
* Quick reference sheet ------- http://drupal.org/handbook/cvs/quickstart
* CVS/Project FAQ ------- http://drupal.org/handbook/cvs/faq

add1sun’s picture

Status: Active » Needs review

I'm going to mark this CNR so we know that the first pass on it is done.

dww’s picture

Once upon a time, when webchick and I wrote/reorganized/edited all of the CVS docs as the "new" release system went live, we identified 2 key audiences for CVS docs:

A) people using CVS to get drupal code, contribute patches, etc.
B) people using CVS to maintain drupal code and contrib projects.

At that time, all the docs were clearly organized with those two audiences in mind. Since then, there have been various edits to the CVS docs that have blurred this distinction, reordered things to break the flow, etc. I haven't been able to keep up.

Sounds like this issue is about re-splitting the docs with these two basic audiences in mind. If that's the goal, big +1 from me. ;)

However, my only concern about moving them too "far" apart in the handbooks is that people in group B also need to read and know all the stuff as the folks in group A. So, wherever the maintainer docs end up, they need to include a lot of cross references to the general CVS docs.

Thanks,
-Derek

Anonymous’s picture

Component: Misc » Other documentation issues
add1sun’s picture

Status: Needs review » Reviewed & tested by the community

yep, the two sections, about CVS and contributing code, will be next to each other in the handbook and cross-linked heavily. :) We should also make sure to keep all of the CVS tool info here and link to it from the setting up a dev env. section.

i'm gonna mark this one RTBC since I think we have marked the pages/sections we need.

dww’s picture

FYI: I unpublished http://drupal.org/node/212366 since it seems like mostly duplicate info, not all of which is actually right. ;) Someone needs to give that page a lot more love before it belongs in the handbooks as if it's discussing "best practices".

add1sun’s picture

Well yeah after the first "gross" reorg, each new section is going to need a thorough review/cleanup. CVS is pretty much at the top of my list for that. :-)

add1sun’s picture

add1sun’s picture

Status: Reviewed & tested by the community » Fixed

Moved and reorganized. Further work on the CVS sections will be in other issues.

Anonymous’s picture

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.