Documentation

[ed]

We need the following outcomes from the work:

• For new technologists to be able to quickly learn:

-- the maintenance and development process,
-- setting up test environments for development work,
-- protocols for contributing to the wiki and the issue tracker,
-- any other key skills and processes related to maintenance and development work.

• Primarily target: Drupal webmasters learning the maintenance/development process, and learning to carry out production tasks (views, panels, etc).
• Provide a specification/description of the site to allow advanced developers a rapid way in to working with it.
• Consider Wordpress users too - with a view to Rob Hopkins moving from Wordpress into Drupal

• Carrying out this work should help Mark to learn the ropes so he can continue to contribute as a technologist.
• Mark will have a a sift through the TRAC tickets - may be able help especially with spam management.
• There is a strict end of January deadline.  

[chris]

Replying to ed:

-- protocols for contributing to the wiki and the issue tracker,

I have created a Trac account for Mark and granted him the same permissions as the rest of us, see:

​https://tech.transitionnetwork.org/trac/admin/general/perm

I have also updated the wiki:TracUserAdmin page.

I have also set Mark up with ssh access to both wiki:NewLiveServer and wiki:DevelopmentServer.

[ed]

Mark added as ticket owner

[chris]

One thought on this, we we do switch to using Octopus / Ageir (see ticket:466), then that is the process and system we need to sort out and document rather than the current process / set up.

[ed]

Confirmed - good thinking

[mark]

Right. I'm rattling on with this now. It's late in the day because (a) there's been some other crap to deal with at my end, but also (b) the BOA process hasn't seemed stable/finished (from my possibly mistaken perspective, anyway).

I'm going to target the "specification/description of the site" and the "protocols for contributing to the wiki and the issue tracker" bits of the above work immediately, as they're straightforward.

With the BOA stuff, can I or should I attempt to:

• create a site with BOA
• use BOA to clone my site (dev)
• create myself a local copy of the dev site
• change my local copy of the dev site
• merge my local copy of the dev site with the BOA-hosted dev site
• back in BOA, merge the dev site back into the live site

...because this is what the website development process will be, won't it?

[mark]

Just logging 3 hours work on this to date, covering reading around, planning and preparing.

[mark]

Have just got the bare bones of some website documentation on the Wiki:
​https://tech.transitionnetwork.org/trac/wiki#Websitedevelopersdesigners-starthere
​https://tech.transitionnetwork.org/trac/wiki/TransitionNetworkWebsite

[mark]

On Tuesday, I drafted this page: ​/trac/wiki/HomePageExplained

[mark]

Just completed the info-graphic for a Views page/section: ​/trac/wiki/ViewBreakdown

[mark]

Drafted "Drupal best practice":
​/trac/wiki/TransitionNetworkWebsite#Drupalbestpractice

Added brief intro to Panels & Context:
​/trac/wiki/TransitionNetworkWebsite#PanelsContext-layoutandBlockmanagement

Trimmed down Drupal intro to be more newb-friendly and better pre-echo the rest of the documentation:
​/trac/wiki/TransitionNetworkWebsite#Drupal

Next up:

• Need to add detail to these sections, and I think break them up into seperate pages.
• Need to start adding in the technical docs/workflow - although I think I'm still waiting on Jim for this.

[mark]

I've done just over a quarter of the 4 days agreed for the documentation work I'm doing. I hope now to pick up the pace and fit in the remaining 3 days over the next 2 weeks - completing the work by the end of March.

[ed]

Great - Jim is hoping to work on the BOA processes and related documentation this week

[ed]

Closing this as it's done