Hi,

On 9/23/19 5:16 PM, Randy Barlow wrote:
Hey Kevin and Petr (and anyone else on the list who is interested),

I've been talking with Ben Cotton about moving the elections
application into Communishift[0]. We had a few back and forth e-mails,
and it became clear that it would be helpful if we had quality
documentation describing how community members can use Communishift.

I think there may need to be a balance between documenting how to use
OpenShift, and linking to already existing resources regarding the use
of OpenShift. Perhaps some simple hello world type examples would be
good to document, but it would probably be best to link to official
OpenShift documentation for details on how to use OpenShift.

On the other hand, there are likely to be some particularities with how
we have deployed/configured Communishift that should be documented.
Since we are hoping to hand off several infrastructure applications to
the community, there may be some common patterns among those apps that
would be good to document as well.


Yeah, that sounds reasonable. I did something similar with the Taiga docs that I wrote up some months ago (and that ended up unused :). They generally focus on things that are specific to Fedora, and link to the full Taiga documentation elsewhere for those who want more details. It's a good approach to take when there's upstream documentation available.


It would also be good to document best practices suggestions for some
common problems our users will need to solve:

* How can they use persistent storage?
* How can they use a database?
* How can they back up the applications, persistent storage, and
  database?

We do have a wiki page[1] for Communishift already that we can use as a
starting point, but we probably want to move it to our documentation
project as we extend it.

Let me know if you are interested in participating in this project.


Sure! You guys are the experts and you know all about what people need to do and how to do it, so it's best if you do most of the actual content writing; I'm happy to help you with markup, structure and that sort of stuff. Some basic info about how the docs site works is in the template repo README: https://pagure.io/fedora-docs/template

Once we have something publishable I'll add it to the site and link it from https://docs.fedoraproject.org/en-US/engineering/


[0] Communishift is an OpenShift instance hosted by Fedora
    Infrastructure for the community to use to host applications for
    Fedora. Fedora Infrastructure does not maintain or administrate any
    applications in Communishift, but rather administers the OpenShift
    deployment itself.
[1] https://fedoraproject.org/wiki/Infrastructure/Communishift

_______________________________________________
infrastructure mailing list -- infrastructure@lists.fedoraproject.org
To unsubscribe send an email to infrastructure-leave@lists.fedoraproject.org
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/infrastructure@lists.fedoraproject.org
--

Petr Bokoč

Senior Technical Writer, Fedora/CentOS