[Pulp-list] Feature Design Pages

Jason Dobies jason.dobies at redhat.com
Mon Jun 14 12:53:01 UTC 2010


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

There is a section on the pulp wiki under design for "features". Without
being too strict about it, I'd like to see some consistency in those
pages where it applies.

Looking at the Package Dependency Resolution page, I'm thinking as a
template:


== Overview ==

== Use Cases ==

== [feature-specific design sections] ==


It's not much, which I think is a good thing; I don't want us to
shoe-horn docs into an overly verbose template that makes them awkward
to read. But at the same time, I think it's important that we describe
what the feature is and how it's going to be used. After that, add any
sections on design, API, DB model, etc.

It should hopefully give the wiki docs a bit of consistency and keep
them from looking like a dumping ground for ideas.

Thoughts?

- -- 
Jason Dobies
RHCE# 805008743336126
Freenode: jdob
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.14 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJMFiYtAAoJEOMmcTqOSQHCCU4H/i6mKG9wMl3qhOTdnb8LEgOU
ytQ2rYd+u2xIrIAbj4olU/WhB0rIeXtsy8iIAUkOAa2pIWmiwO3MTmzCD3Ti91LC
mAuj68JkfTPEcwlx/uM2MvmHzHDs0CCQjYTiSpt75Xm+usgqZFTgu0CfnhfFSLHc
oFnMG8OJ/SY+t5xDFhZJhzPgwDmEVlfehEPCMwNJFnYoEr2BwpU6975i2g5oV1AD
gU61g2XAsvcUkhZ31XwOLzncfWD/FbrtLSEQoHYFtBCfXzeJ+1GkcgL3Tx1wFGtb
U+7HOm8XY7D3Rx9xAol2sAaO5VwkmAhg4yrEINC5C236lgchztv+5HpWgjpvVmI=
=NMGP
-----END PGP SIGNATURE-----




More information about the Pulp-list mailing list