diff --git a/documentation/toaster-manual/toaster-manual-intro.xml b/documentation/toaster-manual/toaster-manual-intro.xml index 86acac2508..36c3b6bdc0 100644 --- a/documentation/toaster-manual/toaster-manual-intro.xml +++ b/documentation/toaster-manual/toaster-manual-intro.xml @@ -93,295 +93,6 @@ REST API Contracts Wiki page. - -
- Manual development notes: - - - - Need chapter on getting your system ready for Toaster and - installing Toaster. - Probably should consider some past releases of YP in here - one way or another. - - - Need a chapter on configuring Toaster. - - - Need a chapter on setting up instances of Toaster. - We will want two sub-sections here: 1) a local instance, and - 2) a production instance. - - - Need a chapter on starting and stopping Toaster. - Need to cover starting in managed mode here. - - - We need a chapter on the user interface. - Need to decide if we want to stick with the slick videos that - currently live on the YP site. - Pros for this are they are cool and convey information nicely. - Cons are they are release dependent and would be high - maintenance over the long haul. - Standard practices usually dictate going with a method that - is as divorced as possible from video shots and images of - actual GUIs for a product. - Rationale is that a person can invoke the tool and see the - actual GUI as they read along with any documentation. - Changing textual descriptions is a lot less headache than - updating videos and screenshots. - - - We need a chapter on Toaster's build functionality. - My understanding is that this is the new thing for 1.8. - Here are some topics identified that would translate into - individual sections: - - - Using Virtualenv - - - manage.py commands - - - Custom layer index - - - I lifted these from the - wiki. - Some items in the list, such as configuration and setting - up instances of Toaster, will be covered in different - chapters. - - - Could think about a chapter on using Toaster to debug common - issues such as failed dependencies and whatever would be - something people might run into. - - - Could maybe include a chapter on the database and other - "under-the-cover" stuff that might be useful. - I am not sure if any of it would be but it is a thought. - - -
- - - - - -