Sorry about that everyone; that's what I get for trying to send my contribution to this discussion from an iPhone.
Anyway, it seems to me like we could try to provide documentation on a modular basis where the structure of the documentation mirrors the structure of the software. Then, we can compile guides where the maintenance on the guides is focused on the metacontent which links the modules to one another. The Security Guide, for example, could contain an introductory section discussing security from a theoretical standpoint and demonstrating how the security components in Fedora match up with the theoretical areas being discussed.
Then, the sections which provide direct instruction regarding the various software components can be linked to the document which arranges them and provides a theoretical overview for their use.
This structure could be used to facilitate a wiki and guides with little unnecessary administrative overhead: the documentation modules could be more-or-less maintained directly through the wiki and the theoretical stuff would be maintained in the guides which simply integrate and then link to these wiki-maintained modules.
-Dylan
On Tue, Aug 26, 2014 at 12:01 PM, Dylan Combs <dylan.combs@xxxxxxxxx> wrote:
What about a solution in which content is developed more modularly (taking Eric and Bryan's proposals for an independent firewalld document as an example) and then joined together into published guides which provide collections of arranged module snapshots, so to speak.The overall goal would be to have modular documentation where the documentation modules mirror the software modules used in Fedora (such as firewalld or iptables or what-have-you)
On Tuesday, August 26, 2014, Eric H. Christensen <sparks@xxxxxxxxxxxxxxxxx> wrote:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
On Tue, Aug 26, 2014 at 11:39:30AM -0400, Bryan Sutherland wrote:
> I have been a member of Docs for some time, mostly lurking helping out
> when I can try to mod when necessary... My 2 cents on this is that as I put
> in 4 hours of work and was nearly complete on a fairly large update to one
> of the guides, I noticed in the commit email that my work was for naught
> because the manual was removed from active duty, with nothing mentioned in
> any of the meetings... </rant>
Release early, release often? Seriously though, don't hold on to your work... commit it often so that it's in the repos. :) Not sure what guide you were working on but feel free to unretire it if you're going to maintain it (or at least add something to it for the next release). Nothing is ever gone completely. Heck, I've dug stuff out of CVS (stuff older than 6 years) before.
> Anyhow, heres my idea I just came up with since as mentioned direwalld is
> somewhat of a pain. I have successfully used it up until all these new
> feature came in and then things start breaking on me. How about this. I
> know this will sound like a major change (like it probably is), but what if
> we were to switch from a "guides" perspective and move to a Build Your Own
> Manual based on selecting Chapters (i.e. mini guides, or some other
> method...), and having a system build into a guide.
>
> As an example, one could choose from a "Security" section on how Not to
> disable SELinux and survive or A Basic Introduction to firewalld and maybe
> firewalld to Make Your Brain Explode and generate a guide that works for
> the user. I know publican is crying over this idea, (but perhaps that's
> just revenge as I tried and never decided to like working with it).
I believe we're on the same thought process here.
- -- Eric
- --------------------------------------------------
Eric "Sparks" Christensen
Fedora Project
sparks@xxxxxxxxxxxxxxxxx - sparks@xxxxxxxxxx
097C 82C3 52DF C64A 50C2 E3A3 8076 ABDE 024B B3D1
- --------------------------------------------------
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1
iQGcBAEBCgAGBQJT/KxoAAoJEB/kgVGp2CYvR7sL/iRKc0ilut8QfxusXqF+t8to
m5tFxcXAEnRuRZ96XjtEPG3JO3GSJ9sTApda7XhTUU7WDNtlfRr5xiiYFTCroW5/
Yndl0lDBdvo1mmt6PfS8nTfyg9sT0aXShP21Aj9a2SKsGKbI4QDy043v0C8eZtth
CSEvEHgJlWjQLF5jBMktWcQu9tuSc0mmeK8TTg933UiUR/vvDIH6l0c/E2JPW0OT
UYjOxoi+cZmkmf9eYFNlYj8PRAAYMTHYv3NMcRjSkrj1tnI3U89FbiYmwWFAYp8r
AceK4VVfK6Yw3T7jbgwHhQx1FvtDF+BbReEewAtTud7dJ+LwCzZgYCrWzvMhhYYs
SEbTg7aPkI/8g+1TuNlYJJIQk4MaItoXjKLjTvYYZZMxsf1oPr894Hgs8j27V/7H
SvJ5FrCSKEXt5n9CIdMWKBexV4czKEnOFghmOxzdvLkGll1SGxn6tRkVuWZw1ot4
DfKhOg9iSYdgiWDtVW44IhPjcrpPNTG/9f58eaDGmQ==
=WrwU
-----END PGP SIGNATURE-----
--
docs mailing list
docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe:
https://admin.fedoraproject.org/mailman/listinfo/docs
-- docs mailing list docs@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe: https://admin.fedoraproject.org/mailman/listinfo/docs
