Re: Fedora Cloud Docs
Reviving and being evil by top-posting, sorry. Let's just pick one and get moving? This languished in the "let's all discuss myriad options" and never quite moved forward. Talked to Kushal this morning and the importance of documentation came up, we should make this a priority for F23. Best, jzb - Original Message - > From: "David Gay" > To: "Fedora Cloud SIG" > Sent: Tuesday, March 24, 2015 5:21:23 PM > Subject: Re: Fedora Cloud Docs > > - Original Message - > > From: "Pete Travis" > > To: "Fedora Cloud SIG" , j...@redhat.com > > Sent: Tuesday, March 24, 2015 11:04:00 AM > > Subject: Re: Fedora Cloud Docs > > > > > > > > > > On Mar 24, 2015 11:38 AM, "Joe Brockmeier" < j...@redhat.com > wrote: > > > > > > On 03/24/2015 01:01 PM, Jared K. Smith wrote: > > > > > > > > If there's a particular cloud-related topic you'd like to write about > > > > -- > > > > go write! And then we can worry about the tooling, once there's some > > > > content to work with. > > > > > > I agree...ish. If Kushal, myself, mattdm, and jbrooks (for example) are > > > collaborating on a document, we really need a single format to target. > > > > > > Best, > > > > > > jzb > > > -- > > > > > > > I was actually polling about preferred markup format, because I am writing > > tools, but Jared is right: don't let things like my misadventures with > > python hold you back! Start now, don't worry about formats, docs will > > handle > > the business of publishing and converting. > > > > --Pete > > > > ___ > > cloud mailing list > > cloud@lists.fedoraproject.org > > https://admin.fedoraproject.org/mailman/listinfo/cloud > > Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct > > > > I think it'd be good to have at least all *our* (Cloud) docs in one format. I > think it'd be a good idea to have that vote on markdown, rst, or otherwise. > > Of course, not being sure of that format yet doesn't mean you can't do some > writing now. > > My two cents. > -- David > ___ > cloud mailing list > cloud@lists.fedoraproject.org > https://admin.fedoraproject.org/mailman/listinfo/cloud > Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct > -- Joe Brockmeier | Principal Cloud & Storage Analyst j...@redhat.com | http://community.redhat.com/ Twitter: @jzb | http://dissociatedpress.net/ ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On 24/03/15, M. Edward (Ed) Borasky wrote: > I'm game to learn Sphinx and rST - I'm a heavy Markdown user already > and Eric Holscher's almost persuaded me rST is significantly better. > ;-) What time zone are you in? I'm in US Pacific Daylight - UTC - 7 > hours. > I should be available on IRC in the early morning hours of yours. Nick name is kushal. Meanwhile you can also start from [1]. [1] http://dgplug.org/irclogs/2012/rst-primer/ Kushal -- Fedora Cloud Engineer CPython Core Developer Director @ Python Software Foundation http://kushaldas.in ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
I'm game to learn Sphinx and rST - I'm a heavy Markdown user already and Eric Holscher's almost persuaded me rST is significantly better. ;-) What time zone are you in? I'm in US Pacific Daylight - UTC - 7 hours. On Thu, Mar 19, 2015 at 2:29 AM, Kushal Das wrote: > On 18/03/15, Pete Travis wrote: >> Hey cloud team, >> >> I think we need some cloud docs. Fedora has a lot to offer in the cloud >> area, and I'm sure that those engaged in the space are excited that >> Fedora has what they are looking for. The uninitiated, on the other >> hand, are looking for what Fedora has, and we can do better to >> demonstrate that. >> >> We have a cloud guide, >> https://git.fedorahosted.org/cgit/docs/cloud-guide.git/ . It covers >> some basics, ie euca2ools, but never really made it out of draft state, >> and your work has left it far behind. We don't have anyone on the Docs >> team fully engaged to track the cloud space, or anyone on the cloud team >> engaged to maintain that guide. Also, it's written in docbook, and a >> lot of folks aren't into that. >> >> So, as I'm working on some tooling for a new Fedora Docs site, I'd like >> to know what would get *you* into writing about Fedora Cloud. In the >> most direct sense, it's a question about markup and delivery, ie a >> collection of markdown or reStructuredText files in a git repo. In a >> broad sense, anything along the lines of "I would write docs for using >> Fedora Cloud, if..." would be great. > Personally it will be easier if we start using Sphinx along with > reStructruedText. Most of the documents I write[1] or manage[2] are in > Sphinx using rst. It required I can provide IRC classroom trainings and > other training material to get anyone into Sphinx within few hours. > > We can have a Fedora focused theme for Sphinx projects. > > [1] http://worknotes.rtfd.org > [2] http://tunir.rtfd.org > [3] http://pymbook.rtfd.org > > Kushal > -- > Fedora Cloud Engineer > CPython Core Developer > Director @ Python Software Foundation > http://kushaldas.in > ___ > cloud mailing list > cloud@lists.fedoraproject.org > https://admin.fedoraproject.org/mailman/listinfo/cloud > Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct -- OSJourno: Robust Power Tools for Digital Journalists http://www.znmeb.mobi/stories/osjourno-robust-power-tools-for-digital-journalists Remember, if you're traveling to Bactria, Hump Day is Tuesday and Thursday. ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
Docker image is built - https://registry.hub.docker.com/u/znmeb/tech-writing/. The source is on GitHub at https://github.com/znmeb/Fedora-Dockerfiles/tree/tech-writing/tech-writing. This is a branch on a fork of Fedora's Fedora-Dockerfiles. If the project wants a pull request, let me know and I'll send one. It's probably too late to get this into the F22 fedora-dockerfiles package. Contents: python-sphinx-*, pandoc-*, FlightCrew and Calibre for ebook wrangling and a few command-line utilities. At some point when I stop having fun with Project Atomic on Windows Hyper-V I'll update this for F22. On Tue, Mar 24, 2015 at 2:54 PM, M. Edward (Ed) Borasky wrote: > My two cents: > > 1. Pandoc is your friend!!! Write rST, Markdown, AsciiDoc, Textile, > DocBook, LaTeX and a bunch of others and Pandoc translates to HTML, > epub, various other text markups and if you've got the LaTeX tool > chain, PDFs. It will only take me half a day or so to put up a > Dockerfile with these goodies - I'll fork fedora-dockerfiles on GitHub > and build this puppy, since I use it heavily. > > 2. Standardization is good - IMHO vital. So let's make a decision that > minimizes the amount of time we waste building tools for ourselves and > standardize on something we can live with. Personally, I think Sphinx > / rST / readthedocs is the best option - I'm a tad biased because I > know some of the creators, but given Pandoc's Markdown - rST > conversion I don't see any reason to use another toolchain. > > > > On Tue, Mar 24, 2015 at 2:21 PM, David Gay wrote: >> - Original Message - >>> From: "Pete Travis" >>> To: "Fedora Cloud SIG" , j...@redhat.com >>> Sent: Tuesday, March 24, 2015 11:04:00 AM >>> Subject: Re: Fedora Cloud Docs >>> >>> >>> >>> >>> On Mar 24, 2015 11:38 AM, "Joe Brockmeier" < j...@redhat.com > wrote: >>> > >>> > On 03/24/2015 01:01 PM, Jared K. Smith wrote: >>> > > >>> > > If there's a particular cloud-related topic you'd like to write about -- >>> > > go write! And then we can worry about the tooling, once there's some >>> > > content to work with. >>> > >>> > I agree...ish. If Kushal, myself, mattdm, and jbrooks (for example) are >>> > collaborating on a document, we really need a single format to target. >>> > >>> > Best, >>> > >>> > jzb >>> > -- >>> > >>> >>> I was actually polling about preferred markup format, because I am writing >>> tools, but Jared is right: don't let things like my misadventures with >>> python hold you back! Start now, don't worry about formats, docs will handle >>> the business of publishing and converting. >>> >>> --Pete >>> >>> ___ >>> cloud mailing list >>> cloud@lists.fedoraproject.org >>> https://admin.fedoraproject.org/mailman/listinfo/cloud >>> Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct >>> >> >> I think it'd be good to have at least all *our* (Cloud) docs in one format. >> I think it'd be a good idea to have that vote on markdown, rst, or otherwise. >> >> Of course, not being sure of that format yet doesn't mean you can't do some >> writing now. >> >> My two cents. >> -- David >> ___ >> cloud mailing list >> cloud@lists.fedoraproject.org >> https://admin.fedoraproject.org/mailman/listinfo/cloud >> Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct > > > > -- > OSJourno: Robust Power Tools for Digital Journalists > http://www.znmeb.mobi/stories/osjourno-robust-power-tools-for-digital-journalists > > Remember, if you're traveling to Bactria, Hump Day is Tuesday and Thursday. -- OSJourno: Robust Power Tools for Digital Journalists http://www.znmeb.mobi/stories/osjourno-robust-power-tools-for-digital-journalists Remember, if you're traveling to Bactria, Hump Day is Tuesday and Thursday. ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
My two cents: 1. Pandoc is your friend!!! Write rST, Markdown, AsciiDoc, Textile, DocBook, LaTeX and a bunch of others and Pandoc translates to HTML, epub, various other text markups and if you've got the LaTeX tool chain, PDFs. It will only take me half a day or so to put up a Dockerfile with these goodies - I'll fork fedora-dockerfiles on GitHub and build this puppy, since I use it heavily. 2. Standardization is good - IMHO vital. So let's make a decision that minimizes the amount of time we waste building tools for ourselves and standardize on something we can live with. Personally, I think Sphinx / rST / readthedocs is the best option - I'm a tad biased because I know some of the creators, but given Pandoc's Markdown - rST conversion I don't see any reason to use another toolchain. On Tue, Mar 24, 2015 at 2:21 PM, David Gay wrote: > - Original Message - >> From: "Pete Travis" >> To: "Fedora Cloud SIG" , j...@redhat.com >> Sent: Tuesday, March 24, 2015 11:04:00 AM >> Subject: Re: Fedora Cloud Docs >> >> >> >> >> On Mar 24, 2015 11:38 AM, "Joe Brockmeier" < j...@redhat.com > wrote: >> > >> > On 03/24/2015 01:01 PM, Jared K. Smith wrote: >> > > >> > > If there's a particular cloud-related topic you'd like to write about -- >> > > go write! And then we can worry about the tooling, once there's some >> > > content to work with. >> > >> > I agree...ish. If Kushal, myself, mattdm, and jbrooks (for example) are >> > collaborating on a document, we really need a single format to target. >> > >> > Best, >> > >> > jzb >> > -- >> > >> >> I was actually polling about preferred markup format, because I am writing >> tools, but Jared is right: don't let things like my misadventures with >> python hold you back! Start now, don't worry about formats, docs will handle >> the business of publishing and converting. >> >> --Pete >> >> ___ >> cloud mailing list >> cloud@lists.fedoraproject.org >> https://admin.fedoraproject.org/mailman/listinfo/cloud >> Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct >> > > I think it'd be good to have at least all *our* (Cloud) docs in one format. I > think it'd be a good idea to have that vote on markdown, rst, or otherwise. > > Of course, not being sure of that format yet doesn't mean you can't do some > writing now. > > My two cents. > -- David > ___ > cloud mailing list > cloud@lists.fedoraproject.org > https://admin.fedoraproject.org/mailman/listinfo/cloud > Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct -- OSJourno: Robust Power Tools for Digital Journalists http://www.znmeb.mobi/stories/osjourno-robust-power-tools-for-digital-journalists Remember, if you're traveling to Bactria, Hump Day is Tuesday and Thursday. ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
- Original Message - > From: "Pete Travis" > To: "Fedora Cloud SIG" , j...@redhat.com > Sent: Tuesday, March 24, 2015 11:04:00 AM > Subject: Re: Fedora Cloud Docs > > > > > On Mar 24, 2015 11:38 AM, "Joe Brockmeier" < j...@redhat.com > wrote: > > > > On 03/24/2015 01:01 PM, Jared K. Smith wrote: > > > > > > If there's a particular cloud-related topic you'd like to write about -- > > > go write! And then we can worry about the tooling, once there's some > > > content to work with. > > > > I agree...ish. If Kushal, myself, mattdm, and jbrooks (for example) are > > collaborating on a document, we really need a single format to target. > > > > Best, > > > > jzb > > -- > > > > I was actually polling about preferred markup format, because I am writing > tools, but Jared is right: don't let things like my misadventures with > python hold you back! Start now, don't worry about formats, docs will handle > the business of publishing and converting. > > --Pete > > ___ > cloud mailing list > cloud@lists.fedoraproject.org > https://admin.fedoraproject.org/mailman/listinfo/cloud > Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct > I think it'd be good to have at least all *our* (Cloud) docs in one format. I think it'd be a good idea to have that vote on markdown, rst, or otherwise. Of course, not being sure of that format yet doesn't mean you can't do some writing now. My two cents. -- David ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On Mar 24, 2015 11:38 AM, "Joe Brockmeier" wrote: > > On 03/24/2015 01:01 PM, Jared K. Smith wrote: > > > > If there's a particular cloud-related topic you'd like to write about -- > > go write! And then we can worry about the tooling, once there's some > > content to work with. > > I agree...ish. If Kushal, myself, mattdm, and jbrooks (for example) are > collaborating on a document, we really need a single format to target. > > Best, > > jzb > -- > I was actually polling about preferred markup format, because I am writing tools, but Jared is right: don't let things like my misadventures with python hold you back! Start now, don't worry about formats, docs will handle the business of publishing and converting. --Pete ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On 03/24/2015 01:01 PM, Jared K. Smith wrote: > > If there's a particular cloud-related topic you'd like to write about -- > go write! And then we can worry about the tooling, once there's some > content to work with. I agree...ish. If Kushal, myself, mattdm, and jbrooks (for example) are collaborating on a document, we really need a single format to target. Best, jzb -- Joe Brockmeier | Principal Cloud & Storage Analyst j...@redhat.com | http://community.redhat.com/ Twitter: @jzb | http://dissociatedpress.net/ signature.asc Description: OpenPGP digital signature ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On Thu, Mar 19, 2015 at 8:20 AM, Kushal Das wrote: > Few advantages of using Sphinx and rst: Slowly catching up on this mailing list, so I apologize in advance for the late reply. The point here isn't to debate "which markup language should we use", it's to solicit volunteers to actually write the *content*. I've volunteered many times before (and will continue to do so) to convert whatever you write in just about any format (text, asciidoc, rst, markdown, pencil and paper) and convert it into DocBook or anything else the Docs team thinks is appropriate. I'll even proofread, edit, and help organize. What we need is content! If there's a particular cloud-related topic you'd like to write about -- go write! And then we can worry about the tooling, once there's some content to work with. -Jared ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On Mar 19, 2015 6:21 AM, "Kushal Das" wrote: > > On 19/03/15, Joe Brockmeier wrote: > > On 03/19/2015 01:14 AM, Pete Travis wrote: > > > So, as I'm working on some tooling for a new Fedora Docs site, I'd like > > > to know what would get *you* into writing about Fedora Cloud. In the > > > most direct sense, it's a question about markup and delivery, ie a > > > collection of markdown or reStructuredText files in a git repo. In a > > > broad sense, anything along the lines of "I would write docs for using > > > Fedora Cloud, if..." would be great. > > > > Most of the writing I do is in Markdown. Git + Markdown would be optimal > > as far as I'm concerned. > > > > If a majority of folks who'll contribute are partial to some other > > flavor of light markup, I can go with whatever, but would prefer *not* > > Docbook or MediaWiki. Let's please do something with git to make life > > much easier. > > > Few advantages of using Sphinx and rst: > > 1. Syntax is almost like markdown. > 2. It has more features targeted towards devels. > 3. If we maintain in a public git repo, we can use a service like > readthedocs.org to build and publish the docs, we can have it in the way > of https://docs.djangoproject.com > 4. Many developers in the infra and apps teams are Python users, so they > know/use reStructuredText already. > > Kushal > -- > Fedora Cloud Engineer > CPython Core Developer > Director @ Python Software Foundation > http://kushaldas.in > ___ So we're on the same page, some context: I am working on building a backend using buildbot that we can feed arbitrary git repos containing docs written in $format and built with $tool-for-format. The goal is to have all the Fedora documentation in one well organized place with little to no contributor overhead in the process of turning markup into website. Of course, participation is welcome and encouraged on the tooling side; but I want it to be clear that it should not be a *requirement* for you to care about the tooling. If you are going to write, you should be able to focus on the writing. --Pete ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On 19/03/15, Joe Brockmeier wrote: > On 03/19/2015 08:20 AM, Kushal Das wrote: > > > > 1. Syntax is almost like markdown. > > 2. It has more features targeted towards devels. > > 3. If we maintain in a public git repo, we can use a service like > > readthedocs.org to build and publish the docs, we can have it in the way > > of https://docs.djangoproject.com > > 4. Many developers in the infra and apps teams are Python users, so they > > know/use reStructuredText already. > > How about we create a ticket in Trac and ask everybody to vote w/in some > reasonable timeframe? Sounds good. > > I'm pretty easy, as long as it's something reasonably easy to learn and > can be edited in Vim and other folks will use, I'm happy. The farther I > get from my usual workflow (Linux + git + vim) the harder it'll be for > me to contribute easily. > Let me convince you first then :) Yes, you can just use Linux + git + vim with Sphinx, and that is my workflow too :) Kushal -- Fedora Cloud Engineer CPython Core Developer Director @ Python Software Foundation http://kushaldas.in ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On 03/19/2015 08:20 AM, Kushal Das wrote: > > 1. Syntax is almost like markdown. > 2. It has more features targeted towards devels. > 3. If we maintain in a public git repo, we can use a service like > readthedocs.org to build and publish the docs, we can have it in the way > of https://docs.djangoproject.com > 4. Many developers in the infra and apps teams are Python users, so they > know/use reStructuredText already. How about we create a ticket in Trac and ask everybody to vote w/in some reasonable timeframe? I'm pretty easy, as long as it's something reasonably easy to learn and can be edited in Vim and other folks will use, I'm happy. The farther I get from my usual workflow (Linux + git + vim) the harder it'll be for me to contribute easily. Best, jzb -- Joe Brockmeier | Project Atomic Doer of Things j...@redhat.com | http://community.redhat.com/ Twitter: @jzb | http://dissociatedpress.net/ signature.asc Description: OpenPGP digital signature ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On 19/03/15, Joe Brockmeier wrote: > On 03/19/2015 01:14 AM, Pete Travis wrote: > > So, as I'm working on some tooling for a new Fedora Docs site, I'd like > > to know what would get *you* into writing about Fedora Cloud. In the > > most direct sense, it's a question about markup and delivery, ie a > > collection of markdown or reStructuredText files in a git repo. In a > > broad sense, anything along the lines of "I would write docs for using > > Fedora Cloud, if..." would be great. > > Most of the writing I do is in Markdown. Git + Markdown would be optimal > as far as I'm concerned. > > If a majority of folks who'll contribute are partial to some other > flavor of light markup, I can go with whatever, but would prefer *not* > Docbook or MediaWiki. Let's please do something with git to make life > much easier. > Few advantages of using Sphinx and rst: 1. Syntax is almost like markdown. 2. It has more features targeted towards devels. 3. If we maintain in a public git repo, we can use a service like readthedocs.org to build and publish the docs, we can have it in the way of https://docs.djangoproject.com 4. Many developers in the infra and apps teams are Python users, so they know/use reStructuredText already. Kushal -- Fedora Cloud Engineer CPython Core Developer Director @ Python Software Foundation http://kushaldas.in ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On 03/19/2015 01:14 AM, Pete Travis wrote: > So, as I'm working on some tooling for a new Fedora Docs site, I'd like > to know what would get *you* into writing about Fedora Cloud. In the > most direct sense, it's a question about markup and delivery, ie a > collection of markdown or reStructuredText files in a git repo. In a > broad sense, anything along the lines of "I would write docs for using > Fedora Cloud, if..." would be great. Most of the writing I do is in Markdown. Git + Markdown would be optimal as far as I'm concerned. If a majority of folks who'll contribute are partial to some other flavor of light markup, I can go with whatever, but would prefer *not* Docbook or MediaWiki. Let's please do something with git to make life much easier. Thanks for bringing this up! jzb -- Joe Brockmeier | Project Atomic Doer of Things j...@redhat.com | http://community.redhat.com/ Twitter: @jzb | http://dissociatedpress.net/ signature.asc Description: OpenPGP digital signature ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On 18/03/15, Pete Travis wrote: > Hey cloud team, > > I think we need some cloud docs. Fedora has a lot to offer in the cloud > area, and I'm sure that those engaged in the space are excited that > Fedora has what they are looking for. The uninitiated, on the other > hand, are looking for what Fedora has, and we can do better to > demonstrate that. > > We have a cloud guide, > https://git.fedorahosted.org/cgit/docs/cloud-guide.git/ . It covers > some basics, ie euca2ools, but never really made it out of draft state, > and your work has left it far behind. We don't have anyone on the Docs > team fully engaged to track the cloud space, or anyone on the cloud team > engaged to maintain that guide. Also, it's written in docbook, and a > lot of folks aren't into that. > > So, as I'm working on some tooling for a new Fedora Docs site, I'd like > to know what would get *you* into writing about Fedora Cloud. In the > most direct sense, it's a question about markup and delivery, ie a > collection of markdown or reStructuredText files in a git repo. In a > broad sense, anything along the lines of "I would write docs for using > Fedora Cloud, if..." would be great. Personally it will be easier if we start using Sphinx along with reStructruedText. Most of the documents I write[1] or manage[2] are in Sphinx using rst. It required I can provide IRC classroom trainings and other training material to get anyone into Sphinx within few hours. We can have a Fedora focused theme for Sphinx projects. [1] http://worknotes.rtfd.org [2] http://tunir.rtfd.org [3] http://pymbook.rtfd.org Kushal -- Fedora Cloud Engineer CPython Core Developer Director @ Python Software Foundation http://kushaldas.in ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Re: Fedora Cloud Docs
On Wed, Mar 18, 2015 at 10:14 PM, Pete Travis wrote: > Hey cloud team, > > I think we need some cloud docs. Fedora has a lot to offer in the cloud > area, and I'm sure that those engaged in the space are excited that > Fedora has what they are looking for. The uninitiated, on the other > hand, are looking for what Fedora has, and we can do better to > demonstrate that. > > We have a cloud guide, > https://git.fedorahosted.org/cgit/docs/cloud-guide.git/ . It covers > some basics, ie euca2ools, but never really made it out of draft state, > and your work has left it far behind. We don't have anyone on the Docs > team fully engaged to track the cloud space, or anyone on the cloud team > engaged to maintain that guide. Also, it's written in docbook, and a > lot of folks aren't into that. > > So, as I'm working on some tooling for a new Fedora Docs site, I'd like > to know what would get *you* into writing about Fedora Cloud. In the > most direct sense, it's a question about markup and delivery, ie a > collection of markdown or reStructuredText files in a git repo. In a > broad sense, anything along the lines of "I would write docs for using > Fedora Cloud, if..." would be great. > > Hopefully, we can find some balance between cloud and writing expertise > and deliver something exciting. At this point, I'm focusing on enabling > you; let's work that out. > > -- > -- Pete Travis > - Fedora Docs Project Leader > - 'randomuser' on freenode > - immanet...@fedoraproject.org > > > ___ > cloud mailing list > cloud@lists.fedoraproject.org > https://admin.fedoraproject.org/mailman/listinfo/cloud > Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct I'm doing a lot of work with Docker and very little with other "cloud" modalities. I'm building and deploying Docker images on Fedora and would be happy to contribute some writing about them. -- OSJourno: Robust Power Tools for Digital Journalists http://www.znmeb.mobi/stories/osjourno-robust-power-tools-for-digital-journalists Remember, if you're traveling to Bactria, Hump Day is Tuesday and Thursday. ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct
Fedora Cloud Docs
Hey cloud team, I think we need some cloud docs. Fedora has a lot to offer in the cloud area, and I'm sure that those engaged in the space are excited that Fedora has what they are looking for. The uninitiated, on the other hand, are looking for what Fedora has, and we can do better to demonstrate that. We have a cloud guide, https://git.fedorahosted.org/cgit/docs/cloud-guide.git/ . It covers some basics, ie euca2ools, but never really made it out of draft state, and your work has left it far behind. We don't have anyone on the Docs team fully engaged to track the cloud space, or anyone on the cloud team engaged to maintain that guide. Also, it's written in docbook, and a lot of folks aren't into that. So, as I'm working on some tooling for a new Fedora Docs site, I'd like to know what would get *you* into writing about Fedora Cloud. In the most direct sense, it's a question about markup and delivery, ie a collection of markdown or reStructuredText files in a git repo. In a broad sense, anything along the lines of "I would write docs for using Fedora Cloud, if..." would be great. Hopefully, we can find some balance between cloud and writing expertise and deliver something exciting. At this point, I'm focusing on enabling you; let's work that out. -- -- Pete Travis - Fedora Docs Project Leader - 'randomuser' on freenode - immanet...@fedoraproject.org ___ cloud mailing list cloud@lists.fedoraproject.org https://admin.fedoraproject.org/mailman/listinfo/cloud Fedora Code of Conduct: http://fedoraproject.org/code-of-conduct