Difference between revisions of "User:Aeric/Writing and Publishing Guide"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 6: | Line 6: | ||
|- | |- | ||
| Critical Bug Fix | | '''Critical Bug Fix'''<br>Feature not usable. | ||
| valign="top"| | | valign="top"| | ||
* | * | ||
| Line 13: | Line 13: | ||
|- | |- | ||
| Minor Fix or<br>Cosmetic Improvement | | '''Minor Fix''' or<br>'''Cosmetic Improvement''' | ||
| valign="top"| | | valign="top"| | ||
* 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.) | ||
| Line 22: | Line 22: | ||
|- | |- | ||
| New Feature | | '''New Feature''' | ||
| valign="top"| | | valign="top"| | ||
* | * | ||
| valign="top"| | | valign="top"| | ||
* Add to wiki | * Add docs to the LJ wiki | ||
* Add a "Coming soon" entry w/link to docs | * Add a "Coming soon" entry w/link to docs | ||
(There is no "pre-release" wiki.) | (There is no "pre-release" wiki.) | ||
|- | |- | ||
| Dated Release | | '''Dated Release''' | ||
| valign="top"| | | valign="top"| | ||
* First one: Convert Release Notes page from redirect to dated listing | * First one: Convert Release Notes page from redirect to dated listing | ||
| Line 41: | Line 41: | ||
|- | |- | ||
| Versioned (ISV) Release | | '''Versioned (ISV) Release''' | ||
| valign="top"| | | valign="top"| | ||
* Move "Release Notes" page to "Version ## Platform" | * Move "Release Notes" page to "Version ## Platform" | ||
Revision as of 20:44, 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
Feature not usable.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 docs to the LJ 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