Task:Publishing API docs - Revision history

dneary at 13:49, 19 June 2009

2009-06-19T13:49:33Z

← Older revision		Revision as of 13:49, 19 June 2009
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 ~~rame~~ 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 frame would be the Fremantle release cycle.

-	==~~Tasks~~==	+	==Requirements==
-	~~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===
-	* ~~Recover the useful information from the previous discussions - Ferenc knows~~.	+	* Get external library.maemo.org working
-	* ~~Have a look at the best practices around. e.g. http://~~library.gnome.org ~~- what else~~.	+	** Install library.gnome.org and get it working with .debs in a Debian repository rather than building documentation with a .tar.gz
-	* ~~Agree~~ on ~~what we want for~~ maemo.org.	+	** Ensure it detects new releases and rebuilds documentation automatically
		+	** 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

-	~~===Tool & Process===~~	+	After the initial task, there are other issues to resolve:
-	* Define the ~~process.~~	+
-	* Get the commitment from Nokia.	+
-	* Implement the tool.	+

-	~~===Release===~~	+	* Ensure that Doxygen, gtk-doc and qdoc documentation are all consistent in terms of stylesheets & layout
-	* ~~Real content needs to land.~~	+	* Probably others I haven't thought of right now
-	* Test, debug, ~~fine tune.~~	+
-	* ~~Final release.~~	+

qgil at 20:05, 20 July 2008

2008-07-20T20:05:31Z

← Older revision		Revision as of 20:05, 20 July 2008
Line 9:		Line 9:
	===Plan===		===Plan===
	* Recover the useful information from the previous discussions - Ferenc knows.		* Recover the useful information from the previous discussions - Ferenc knows.
-	* Have a look at the best practices around.	+	* Have a look at the best practices around. e.g. http://library.gnome.org - what else.
	* Agree on what we want for maemo.org.		* Agree on what we want for maemo.org.

qgil: New page: {{Template:2010 agenda}} {{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. T...

2008-07-20T20:04:47Z

New page: {{Template:2010 agenda}} {{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. T...

New page

{{Template:2010 agenda}}
{{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 rame would be the Fremantle release cycle.

==Tasks==
We can split the work in three loads adaptable to sprints:

===Plan===
* Recover the useful information from the previous discussions - Ferenc knows.
* Have a look at the best practices around.
* Agree on what we want for maemo.org.

===Tool & Process===
* Define the process.
* Get the commitment from Nokia.
* Implement the tool.

===Release===
* Real content needs to land.
* Test, debug, fine tune.
* Final release.