Drupal.org redesign implementers
Last updated Dec 3, 2009. Updates are marked, and bold.
Your assignment
- Check your assignment at Assignments and Contact Info page. Section names are linked to the prototype. This table will be updated to show who is working on what.
-
You'll be implementing the entire page, based on the prototype provided, including theme and configuration. You are going to checking in your theme changes into your sandbox, which will automatically check out to the staging sites. Code changes need to be created as patches, or new modules that will then be manually updated on your assigned staging site (explained below).
-
There will probably be a lot of coordination with the other implementers, so feel free to connect with each other in IRC.
Important first steps
-
Read Building the Drupal.org re-design community infrastructure: Administrators wanted
This post explains why all development is being done centrally on Drupal.org servers and not on your local environment. -
Ensure the project management team has the names, d.o. username/link to user profile, email and phone number of each person who will be working on the implementation. This is so each person can have the right permissions set up. D.o usernames will be listed on the Assignments and Contact Info page.
Implementers Guide
Contents
- SVN Checkout Instructions
- Staging Sites for Dev and Testing
- Content, Theming, and Development
- Communication and Coordination
- Style Guide and Reference materials
- Asset Management
- Best Practices (tbc)
Last updated Dec 3, 2009. Updates are marked, and bold.
SVN Checkout Instructions
- The svn password is the same as yours for infrastructure.drupal.org (If you don't have an infrastructure.drupal.org account, set one up and Kieran will promote you.)
-
There are two repositories for code:
- The drupal.org repository has the code for drupal.org. There are two branches in it, redesign and production. We're using "redesign" branch. Changes to "production" would end up on the live site, which would not be what we want. People who need to do module development will use this repository. The svn path is https://svn.drupal.org/drupal/drupal.org/redesign.
- The "themes" repository has a sandbox directory that is what we'll use for individual themers. It's a different repository and it has a directory in it called "sandbox". That's where users will create a directory with their own username and put their themes underneath. The path to this is https://svn.drupal.org/drupal/themes/sandbox
-
If you need the actual Drupal code, check out the redesign branch code via SVN:
svn checkout https://svn.drupal.org/drupal/drupal.org/redesign.
It is possible to do a standard Drupal install using this code. A couple of extra things you have to do:- Use scripts/create-users-access.sql to create the users_access table
- Enable the staging_drupal_org module.
Using this technique you can run a very simple (no solr) version of Drupal that uses the bluecheese theme. You can also just work with the bluecheese theme on a standard Drupal install until you like what you get.
-
For theme-only work you will work with a copy of the bluecheese theme in your own sandbox in the themes sandbox. The idea is that you work in the themes repository (not the redesign code repository) and put your own version of bluecheese in sandbox/your_username/bluecheese. The essence of this is that you need to get a copy of the HEAD bluecheese theme into your svn theme sandbox. There are many ways to do this, but I'll suggest one. This assumes you're working in one directory on a Linux-like machine:
svn checkout https://svn.drupal.org/drupal/themes/sandboxchecks out the theming sandbox.cd sandbox
mkdir your_username
That makes a sandbox for you. For example, rfay would usemkdir rfay.cd ..to get back to the original directory.svn co https://svn.drupal.org/drupal/drupal.org/redesign/sites/all/themes/bluecheesechecks out the HEAD version of bluecheese.cd bluecheese
svn export . ../sandbox/your_username/bluecheese
will put the bluecheese code into your sandbox.cd ../sandboxto get back to your sandboxsvn add your_usernameto add it into subversion.- And commit when you have something you want to try out. It will be checked out on the staging servers.
-
After you have checked your theme into your sandbox, it will be checked out every 5 minutes on the staging servers.
-
Make your updates following our best practices outlined below
Staging Sites for Dev and Testing
-
Staging sites: http://staging1.drupal.org through http://staging10.drupal.org. Please see Amazon's post for more details and the Staging*.drupal.org Site Status.
-
Log in on your assigned server and click 'edit' so you can change the theme (just for yourself). Change to your own theme and then explore. (You may need to go to admin/build/themes and enable your new theme from your sandbox.)
- Your assigned staging server will be supplied by one of the.org redesign team members and listed on the Assignments and Contact Info page. The password will be your usual drupal.org password.
You will be sharing your staging server among themers or developers. If you change only your own account's theme there should be no issues with affecting others. -
All implementers on the list should have privileges on the staging site that allow you to configure blocks, create pages etc.
-
TBC: If you make configuration changes or add content, it may be lost during the implementation stage. If your configuration change should be repeated, create an issue to have it added to the drupal_org module.
UPDATE: Put staging server issues in http://drupal.org/project/issues/infrastructure?text=&status=All&priorities=All&categories=All&component=staging.drupal.org
Content, Theming, and Development
If you have been assigned a section of the re-design to implement then you are responsible for the content, theming, and development as specified in the prototype. If you have questions, contact Lisa and Kieran.
Content:
The content is exclusively in the prototype at this point. Add it to your staging server first, and migrate it upstream to Drupal.org. Once it is on Drupal.org, it will appear in your staging site with the next Drupal.org database refresh. If you don't have permission, just contact Lisa or Kieran to publish to on Drupal.org for you.
UPDATE: Put content issues in http://drupal.org/project/redesign. We are still configuring the components.
Theming:
Theming should be implemented first as a Sandbox theme in SVN. Then patches should be added to the BlueCheese issue queue where they will be reviewed for consistency, performance, semantics, and maintainability.
UPDATE: Put Theming issues into .... TBC
Views:
Drupal.org has Views installed for use with the Project module. You have been given permission to create Views as a site administrator. Go ahead and prototype with Views. Ultimately, you must export your View as code and create a patch. Your Views patch will to be reviewed by the production team for performance implications and when approved, will be merged with the drupal.org SVN production branch.
UPDATE: Put exported Views issues in http://drupal.org/project/redesign. We are still configuring the components.
Development / new modules
We are still working out a process for adding modules and patching the redesign branch in SVN. Please work closely with Randy Fay (rfay) and Caleb Gilbert (calebg) through the redesign project issue queue. They may be available to provide support in IRC channel #drupal-infrastructure.
UPDATE: Put Dev / module issues in http://drupal.org/project/redesign. We are still configuring the components.
Users:
The staging sites are sanitized copies of Drupal.org which means the accounts exist, but the emails have been removed for users. Each implementer has been promoted to an administrator on all 10 of the staging sites. Promotion is implemented as a drupal update hook, so it's critical the redesign administrators have your drupal.org username.
UPDATE: (FYI we are gong to be moving the issues out of Issue queue: All Redesign Issues (tagged drupal.org redesign) and re-filing them)
Communication and Coordination
-
If you have any problems, first check to see if someone is already having the same problem, if not, create a new issue
-
UPDATE: We are using both the redesign project and infrastructure project (see above for urls).
-
Once you have created an issue, you can see if someone in #drupal-infrastructure can assist with your issue. The redesign admins are cweagons, amazon, rfay, and calebg. If they can't help you, contact Lisa and Kieran by email and they will
coordinate getting help for you. Don't request help from the productions administrators. They are busy keeping Drupal.org up. -
g.d.o. notifications: please ensure notifications from this group are enabled and being sent to the right email address. These will include comments to wiki pages and discussions.
-
RSS: an RSS feed will supply you with any new pages or discussions (but not comments/replies)
-
IRC: We have a dedicated channel #drupal-infrastructure on irc.freenode.net
-
Please feel free to add comments to discussions and content to wiki pages in this group
Please note, important decisions and outcomes of discussions will be written up and posted in this group.
Style Guide and other Reference Materials
Asset Management
Design comps are being stored and shared at http://www.wuala.com/drupal-redesign. Anyone can download the comps but users must be members to upload. Todd and Aaron at Four Kitchens are the best people to contact concerning this.
How to find things to do
If you aren't a Drupal shop that has been assigned to a section on the site, we be happy to accept contributions by individuals. We will definitely need a lot of testers/reviewers. If you would like to help w/ implementation, contact one of the implementation team.
Best Practices - edit in progress
-
A list of modules that can be used and cannot be used will be provided
-
Familiarize yourself with Drupal best practices for coding and UI text at http://drupal.org/contributors-guide
-
Don't assume someone knows the answer. Document what you learn from people so that others can learn.
-
Be patient. Contact Kieran and Lisa if you have problems, it's our job to get roadblocks out of your way.
