Difference between revisions of "User:Aeric/Writing and Publishing Guide"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 17: | Line 17: | ||
* Modify the '''AA Dev wiki''' page.<br>(Changes will migrate at next dated release.) | * Modify the '''AA Dev wiki''' page.<br>(Changes will migrate at next dated release.) | ||
| valign="top"| | | valign="top"| | ||
'''''When an equivalent AA page is reorganized:''''' | *'''''When an equivalent AA page is reorganized:''''' | ||
* Reflect the reorg in the LJ wiki to ensure that future changes can be made without difficulty. | *: Reflect the reorg in the LJ wiki to ensure that future changes can be made without difficulty. | ||
Skip all other "cosmetic" improvements. | * Skip all other "cosmetic" improvements. | ||
|- | |- | ||
Revision as of 20:41, 20 January 2014
Procedures
The procedure to use depends on the type of activity and the target of that activity.
Activity AgileApps LongJump Critical Bug Fix Minor Fix or
Cosmetic Improvement- Modify the AA Dev wiki page.
(Changes will migrate at next dated release.)
- When an equivalent AA page is reorganized:
- Reflect the reorg in the LJ wiki to ensure that future changes can be made without difficulty.
- Skip all other "cosmetic" improvements.
New Feature - Add to wiki
- Add a "Coming soon" entry w/link to docs
(There is no "pre-release" wiki.)
Dated Release - First one: Convert Release Notes page from redirect to dated listing
- Move features from Coming Soon page to Release Notes page
- Activate "check back" text on Coming Soon page, unless future features remain)
Versioned (ISV) Release - Move "Release Notes" page to "Version ## Platform"
- Activate the redirect on the release notes page
- Move "Release Notes" page to "Version ## Platform"
- Activate the redirect on the release notes page
- Modify the AA Dev wiki page.
New Features
- Document new features in the Dev wiki
http://agileappslive.info/mw_dev - Put a Coming Soon entry into the platform features page, with a Learn More link to that documentation:
http://agileappslive.info/mw_dev/Platform_Features - When that entry is good enough for use, copy it to the production wiki (minus the Learn More link):
http://agileappslive.info/wiki/Platform_Features
Publication Process
First, prepare the development wiki for publication. Then execute the publishing process.
Preparation:
- Find and fix all transclusions of Template:TBD
- In the dev wiki, change the Coming Soon heading to reflect the release date.
http://agileappslive.com/mw_dev/Platform_Features - Leave unimplemented entries under Coming Soon or, if there are none, comment out that section
Publication:
- Using PuTTY, log in to the Rackspace server
- Run scripts/publishDevWiki to copy the contents of the
development wiki (mw_dev) to the production wiki mw_prod- This process makes a backup of the production wiki.
- If there is ever any need to revert to a previous version,
run scripts/restoreWikiInstructions for a list of steps