Documentation Updates¶
This page is a temporary holding area to organize the pages being worked on, until they can be linked in to the official FWD documentation.
RICA stands for the Runtime Installation, Configuration and Administration Guide.
DG stands for Developer Guide.
CH stands for Conversion Handbook.
In each of these cases, it is assumed that we will copy and update the content from the chapters (or parts of chapters) that are being replaced. I have also tried to find (and document) related Redmine tasks that have useful notes. I may have missed something so try to search thoroughly in addition to using the ones I have found.
To get started on your documents, please click on the red link in the "New Page" column that goes with your task. This will create the document the first time you go in. Save your changes and you will see that the link will turn blue. Notify GES when the document is done/ready. GES will handle the linking of these documents into the books.
| New Page | Pages To Be Replaced and Other Notes | Assignee | Status |
|---|---|---|---|
| Conversion Architecture | See https://www.beyondabl.com/#How and the technical description pages from the old web site. See the marketing presentation for diagrams and how it works section. Replaces CH Conversion Technology Architecture, CR Chapter_7_Schema_Conversion, CR Chapter_8_Code_Conversion. Should be added to DG and RICA. | GES | |
| Runtime Architecture | See https://www.beyondabl.com/#How and the technical description pages from the old web site. See the marketing presentation for diagrams and how it works section. Create new diagrams. Replaces DG Chapter_8_Runtime_Environment_Overview and should be added to all 3 other books. | GES | Done |
| System Requirements | This is a new chapter to be linked into RICA before the current chapter 1. Some content needs to be moved here (and updated) from the Developer Guide Chapter_3_Development_Environment_Setup. | GES | Done |
| Software Dependencies | RICA Chapter 1 Software Dependencies and parts of CH Chapter 4 Installation. | HC | Done |
| Building FWD From Source | This will replace RICA Chapter 2 How to Build FWD from Source and it will be referenced by other chapters. Content will be moved from Development Environment Setup | GES | Done |
| Development Environment Setup | Update based on #2699. Replaces DG Chapter_3_Development_Environment_Setup. | HC | Done |
| Development Environment Setup and Building FWD on Windows | Uses content from #1928. Update based on #2699. Uses content from DG Chapter_3_Development_Environment_Setup and RICA Chapter 2 How to Build FWD from Source | EVL | Done |
| Conversion Environment Setup | Replaces CH Chapter 4 Installation. | GES | Done |
| Application Server Setup - Linux | Replaces RICA Chapter 3 Application Server Installation and parts of CH Chapter 4 Installation | CA | Done |
| Application Server Setup - Windows | New chapter added to RICA. Use content from #1928, #2332, RICA Chapter 3 Application Server Installation and parts of CH Chapter 4 Installation | EVL | Done |
| Client Installation - Linux | Replaces RICA Chapter 4 Client Installation and parts of CH Chapter 4 Installation. This should also comprehensively address Patching and Building NCURSES/TERMINFO (see DG Chapter_3_Development_Environment_Setup and the client parts of CH Chapter 4 Installation). | CA | Done |
| Client Installation - Windows | Uses content from #1928, RICA Chapter 4 Client Installation and parts of CH Chapter 4 Installation. | EVL | Done |
| Database Server Setup for PostgreSQL on Linux | Please see #1866-6 (and the rest of that task) for many useful updates and clarifications. Combine this with the content from the documents it is replacing in RICA Chapter 5 Database Setup and parts of CH Chapter 4 Installation. | ECF | Done |
| Database Server Setup for SQLServer on Windows | Will be linked in to the RICA, doesn't have an existing chapter to replace. Use #2332 and #1656 (use all the subtasks!). Some content of RICA Chapter 5 Database Setup and parts of CH Chapter 4 Installation will be useful. | OM | Done |
| Database Server Setup for H2 | Will be linked in to the RICA, doesn't have an existing chapter to replace. There is useful content (specific to H2!) in CH Chapter 4 Installation and in DG Chapter_3_Development_Environment_Setup | OM | Done |
| Data Migration | Do we need any content specific to PostgreSQL or SQLServer (see #3202 and #2142 for SQLServer import tasks)? Replaces RICA Chapter 6 Data Migration and CH Chapter 19 Data Migration | ECF | Done |
| Quick Start | Rewrite this using the demo templates as the basis. Update the CH Quick Start. Should also be added as a new chapter to the DG. | GES | Done |
| Patching and Building Customized 3rd Party Libraries | Replaces DG Chapter_4_Advanced_Setup. There should be up to date sections on Hibernate, PL/Java and H2. Jetty is the stock version now so it can be dropped. | SVL | Done |
| Running the Server | Just needs to be updated. | GES | Done |
| Running the Client | Just needs to be updated. | GES | |
| Automating Installation | Development of scripts to automate the installation processes and instructions on how to use them. | CA | WIP |
| Batch Processes | Details on how to configure and launch batch processes. | CA | WIP |
Pages that become dead will be linked into Obsolete so that we can go back and review the history. This will allow us to recover any text that we may have previously had but which didn't get copied into the newer documents. In other words, do NOT delete any wiki pages.
The following links have useful wiki/textile usage help:
The first two are "official" Redmine docs. They provide good details on the specific textile variant used by Redmine (plus its extensions). The 3rd is written by me and it has lots of tricks that I found through trial and error.
The last reference is for "generic" textile and some of the things documented there won't work in Redmine. Please also note that for security reasons we remove (filter) inline HTML from textile docs in Redmine. This keeps us safe, but it removes some formatting that otherwise would be possible.
Finally, Eugenie and myself both have some pretty advanced Redmine wiki ninja skills. Please ask us for help as needed.
© 2004-2017 Golden Code Development Corporation. ALL RIGHTS RESERVED.