| 1 |
-----BEGIN PGP SIGNED MESSAGE----- |
| 2 |
Hash: SHA1 |
| 3 |
|
| 4 |
I think we might consider a split on documentation target |
| 5 |
|
| 6 |
On Thursday 23 October 2003 09:30, Sven Vermeulen wrote: |
| 7 |
> (1) Link all documentation on the documentation index, but keep the |
| 8 |
> documentation where it is. This however has one big disadvantage, |
| 9 |
> which is that only a very very very small part of the documentation |
| 10 |
> team can do editing on those documents (one person most of the time). |
| 11 |
> The result is that installation-related documents are quickly outdated |
| 12 |
> (our installation guide changes a lot, and with the upcoming handbook |
| 13 |
> this won't change :) because the documentation team can't update the |
| 14 |
> related documents. |
| 15 |
|
| 16 |
Developer related documentation can go here, however we need to get some |
| 17 |
good procedure for publishing links to these documents in an index. |
| 18 |
|
| 19 |
> |
| 20 |
> (2) Move all documentation in the documentation repository and link |
| 21 |
> those on the index page. This however has one big disadvantage, which |
| 22 |
> is that only a small part of the respective project (clusters, |
| 23 |
> hardened, metastructure) have access to the documentation for updates. |
| 24 |
> |
| 25 |
|
| 26 |
User documentation should go here. It is more critical on correctness and |
| 27 |
readability. It probably also creates more confusion if it not |
| 28 |
maintained by documentation. |
| 29 |
|
| 30 |
> In the eyes of the documentation development, this latter is |
| 31 |
> preferred: at least one person of each project has (or should have) |
| 32 |
> access to the documentation cvs (see the "Project Doc Editor" at |
| 33 |
> http://www.gentoo.org/proj/en/gdp). Further more, updates to |
| 34 |
> documentation shouldn't be a one-man change -- a second "opinion" must |
| 35 |
> be established (we just call it reviewing) so that no major mistakes |
| 36 |
> are made (we are all human). |
| 37 |
|
| 38 |
> Are there objections if I would suggest to implement the second |
| 39 |
> proposal (i.e. migrate documentation to the documentation directory)? |
| 40 |
|
| 41 |
For user related docs not at all. I think that developer related |
| 42 |
documentation (esp. that which is still in state of development) can |
| 43 |
stay in the project directories. However I agree with robbat2 on |
| 44 |
exploring ACL's |
| 45 |
|
| 46 |
Paul |
| 47 |
|
| 48 |
- -- |
| 49 |
Paul de Vrieze |
| 50 |
Gentoo Developer |
| 51 |
Mail: pauldv@g.o |
| 52 |
Homepage: http://www.devrieze.net |
| 53 |
-----BEGIN PGP SIGNATURE----- |
| 54 |
Version: GnuPG v1.2.3 (GNU/Linux) |
| 55 |
|
| 56 |
iD8DBQE/l5Z1bKx5DBjWFdsRArSFAJ4qapZKiLAxHSp8XmbgpsopaHH2hACfYTPW |
| 57 |
JlOYnwo2infMW7tijv3/5mY= |
| 58 |
=vrCM |
| 59 |
-----END PGP SIGNATURE----- |
| 60 |
|
| 61 |
|
| 62 |
-- |
| 63 |
gentoo-dev@g.o mailing list |
Archives