Editing Task:Publishing API docs

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 2: Line 2:
{{task|proposed}}
{{task|proposed}}
-
Currently the API docs are spread in different spaces and are processed through different tools. We need a unified process and a single place. This task needs to be done in collaboration with the Nokia teams. The ideal time frame would be the Fremantle release cycle.
+
Currently the API docs are spread in different spaces and are processed through different tools. We need a unified process and a single place. This task needs to be done in collaboration with the Nokia teams. The ideal time rame would be the Fremantle release cycle.
-
==Requirements==
+
==Tasks==
-
 
+
We can split the work in three loads adaptable to sprints:
-
An API doc publishing system should fulfill a few basic requirements:
+
-
 
+
-
* Automated: When a new version of a package is released, the API documentation should be updated accordingly, with no human intervention
+
-
* Searchable: You should be able to search API docs by function name, or by task (free text)
+
-
* Complete: All API references should be documented, and be up to date.
+
-
* Works internally & externally: Unreleased APIs should have in-progress API documentation visible on the Nokia intranet, released packages should have their API documentation automatically updated on an external site
+
===Plan===
===Plan===
-
* Get external library.maemo.org working
+
* Recover the useful information from the previous discussions - Ferenc knows.
-
** Install library.gnome.org and get it working with .debs in a Debian repository rather than building documentation with a .tar.gz
+
* Have a look at the best practices around. e.g. http://library.gnome.org - what else.
-
** Ensure it detects new releases and rebuilds documentation automatically
+
* Agree on what we want for maemo.org.
-
** Set it loose on Maemo's repository with a starting module list
+
-
** Work on look & feed of front page to ensure it integrates well with the rest of maemo.org
+
-
* Get internal library working
+
-
** Manage internal releases, define repository for in-progress API docs
+
-
After the initial task, there are other issues to resolve:
+
===Tool & Process===
 +
* Define the process.
 +
* Get the commitment from Nokia.
 +
* Implement the tool.
-
* Ensure that Doxygen, gtk-doc and qdoc documentation are all consistent in terms of stylesheets & layout
+
===Release===
-
* Probably others I haven't thought of right now
+
* Real content needs to land.
 +
* Test, debug, fine tune.
 +
* Final release.

Learn more about Contributing to the wiki.


Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!


Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "http://wiki.maemo.org/Task:Publishing_API_docs"