summaryrefslogtreecommitdiff
path: root/TODO
blob: 4307de53fed02832bddd7c1949823f40b762e06a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
                            DocKnot To-Do List

This file contains loose development notes for the current state of this
project.  Listed here are only the things left to be done.

Metadata required for README files:

* Contributor information (step-by-step guide, checklists)
* Generate a separate install file for Debian packaging
* Pointers to long licenses
* Where releases are announced
* Quick-start guide
* Jargon
* Release schedule
* Contributor SLA

Metadata required for web pages:

* Short description for index
* Category (obsolete packages have their pages manually maintained)

Metadata required for release:

* License overrides for build-license
* Default license for build-license

Additional output:

* Per-package RSS files from NEWS, excluding unreleased versions
* Generate external pointer files for spin for package documentation
* Update my software index
* Update my web site sitemap
* Set Open HUB metadata from package metadata via API

DocKnot itself:

* Pull the version number of a package from a single source
* Pull the synopsis for a Perl module from the Perl build system
* Document the metadata format
* Incorporate cvs2xhtml into this package
* Incorporate faq2html into this package (and rewrite as a Perl module)
* Incorporate build-license into this package (and rewrite as a Perl module)
* Automatically run build-license during the release process
* Add metadata files and overrides to build-license