E-Commerce project stands out from many other drupal contributions, mainly in size. Recently, access to Drupal CVS was tightened, allowing a project owner to specify who has access to the project. gordon has taken advantage of this, for obvious reasons.
So, at the moment, I've got the job of updating README files. I've decided to create this thread in order to inform you how I intend to do that, so you'll know what the heck is going on.
README.txt (the main one)
Found in the ecommerce root directory. This document will be kept minimal, a broad overview with links to further reading. It currently contains four main sections.
- title and links
- description
- installation
- module summary
This file is kept identical between 4.7 and CVS.
MAINTAINERS.txt
Found in the ecommerce root directory. Previously there was a MAINTAINERS file in every module directory. These have all been deleted, and now there is only a single file which is structured more like the drupal core MAINTAINERS file.
The first section shows "Core Maintainers", all of whom have CVS access with certain responsibilities. The second section lists each of the modules in /contrib and those who are currently responsible for them.
This file is also kept identical between 4.7 and CVS.
INSTALL.txt (with each module)
These have all been removed. Install instructions that are module-specific are now found in the README.
CHANGELOG.txt (with each module)
These have all been removed. Better information is found in CVS, by reviewing commit history and messages.
README.txt (with each module)
We are keeping a README for each module, although much of the information is taken out to avoid duplication with the main README. Only the original author is mentioned here (although sometimes it is the same as the current MAINTAINER) - so at the end of each README the reader is directed to the README and MAINTAINERS in root.
The sections and information depend on the module itself. Some require extra installation instructions, some have a thankyou section etc.
To avoid unecessary maintenance work, the module-specific READMEs in CVS will only contain information about the next version - sometimes nothing.
Cheers
So any ideas or concerns please leave a note here, or if you have suggested changes, check them into the issues queue.
Just to conclude, I am not the one to speak to about the developer docs in CVS (which is probably a good thing). neclimdul is responsible for these docs including /docs/developer/hooks/core.php which contains the ecommerce API documentation.
Cheers
Simon