[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
[geclipse-dev] Documentation structure
|
Hello All!
In attachment you find proposition of new structure for our documentation.
Short summary:
1. We still have chapter "Concepts"
-here general, middleware independent concepts will be discussed.
-if given functionality is not developed as general solution, then it
won't appear here (for example downloading of Logging&Bookkeeping logs).
-all screenshots here should not contain dialogs specific for middleware.
2. We have additional chapter "Middlewares", where all concepts will be
discused again from given middleware point of view.
- if given functionality is not developed for given middleware, then
won't appear here (e.g. Visualisation for GRIA)
- here will be links to documents from chapter "Concepts". For example:
"GRIA / Job Management / Updating job status" will be exactly the same
document as "Concepts / Job Management / Updating job status".
This will be links to original documents, not copy.
- middleware depended settings for given functionality will be described
here
If there are no objections about new structure, I will create skeleton
of it in our doc plugins.
Some html documents are written in middleware dependent way: I will
remain it in general "Concept" chapter and ask responsible developer to
split document to two parts: middleware independent and dependent.
Any comments are welcome.
P.S. To create link to document from other plugin we can use following
technique:
<topic label="Creating Connections"
href="../eu.geclipse.doc.user/html/concepts/connections/creating.html" />
--
Regards,
Mariusz and Moritz
