[mod_cluster-issues] [JBoss JIRA] (MODCLUSTER-474) Provide means of having on-line editable, simple markup static documentation and FAQ presentation

Michal Karm Babacek (JIRA) issues at jboss.org
Wed Jan 6 11:35:00 EST 2016


     [ https://issues.jboss.org/browse/MODCLUSTER-474?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michal Karm Babacek resolved MODCLUSTER-474.
--------------------------------------------
    Resolution: Done


h3. [modcluster.io|http://modcluster.io/]
* Jekyll generated static web page
* content written in Markdown
* uses GitHub's Git Large File Storage for released bits (1.3.1.Final now)
* GitHub Pages for Jekyll SaaS hosting, i.e. one pushes Markdown and GitHub generates HTML from it
 * a substantial amount of former Docbook text ported (it's still work in progress)
 * all examples ported from former Github wiki page that is dead now
 * all release notes ported and enriched with links to releases and JIRA issues

h3. Communication
Furthermore, there is a new #mod_cluster IRC channel on Freenode and modcluster Slack team space. Slack is interlinked with IRC, so user's messages sent to IRC end up on our Slack and vise versa. This neatly solves the issue of off-line message delivery absent on IRC.
See [modcluster.io|http://modcluster.io]'s left sidebar for links to channels.

h3. Further steps
* finish porting and re-organization of the [main documentation page|http://modcluster.io/documentation/]
* create Undertow section and interlink it with the upstream Undertow documentation so as users have all Apache/Undertow mod_cluster capabilities descriptions reachable from a one place
* add new examples and FAQ based on most frequent JBoss  forums and Stackoverflow questions (an ongoing effort)
* apart from Docker image for Apache HTTP Server, also create and promote pre-configured Tomcat images with mod_cluster
* include Azure tutorial for configuring dynamic mod_cluster environment
* include Tutum Docker tutorial for orchestration of many mod_cluster containers
* include links to Fedora mod_cluster RPMs https://karm.fedorapeople.org/mod_cluster/ and pre-build these for major x86_64 Fedora releases
* include reference to Circle CI nightly build of mod_cluster for Linux x86_64

> Provide means of having on-line editable, simple markup static documentation and FAQ presentation
> -------------------------------------------------------------------------------------------------
>
>                 Key: MODCLUSTER-474
>                 URL: https://issues.jboss.org/browse/MODCLUSTER-474
>             Project: mod_cluster
>          Issue Type: Task
>            Reporter: Michal Karm Babacek
>            Assignee: Michal Karm Babacek
>            Priority: Critical
>              Labels: documentation, ux
>
> h3. Requirements
> * Markdown (or other simple markup)
> * Statically generated
> * outsourced hosting for web
> * outsourced hosting for released bits



--
This message was sent by Atlassian JIRA
(v6.4.11#64026)


More information about the mod_cluster-issues mailing list