From: Tomas Sedovic <[email protected]> Changed formatting so that the page better communicates how to contribute to the project. --- deltacloud.org/content/_contribute.haml | 40 +++++++++++++++++++++++++ deltacloud.org/content/_readme.haml | 6 ++++ deltacloud.org/content/contribute.haml | 48 ++++++++++++------------------ 3 files changed, 65 insertions(+), 29 deletions(-) create mode 100644 deltacloud.org/content/_contribute.haml create mode 100644 deltacloud.org/content/_readme.haml
diff --git a/deltacloud.org/content/_contribute.haml b/deltacloud.org/content/_contribute.haml new file mode 100644 index 0000000..2708ff0 --- /dev/null +++ b/deltacloud.org/content/_contribute.haml @@ -0,0 +1,40 @@ +--- +filter: + - haml +--- +:markdown + Contribute + ========== + + All development of Deltacloud takes place in the open. Communication is run through the mailing list and all source code changes are tracked publicly. + +%ul + %li + %h3 Mailing Lists + :markdown + We have two lists, one for [user questions][1], and one for [development discussions and patches][2]. + + [1]: https://fedorahosted.org/mailman/listinfo/deltacloud-users + [2]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel + %li + %h3 IRC + :markdown + You can also join us on the Freenode IRC channel #deltacloud. Deltacloud developers are generally available on the IRC channel, but if you do not get a response to a posted question on the IRC channel please ask on the [user mailing list][3]. + + [3]: https://fedorahosted.org/mailman/listinfo/deltacloud-users + %li + %h3 Bugs + :markdown + We track bugs in [Red Hat Bugzilla][4]. You can [view open bugs][view-bugs] or [file a new one][new-bug] there. + + [4]: https://bugzilla.redhat.com/ + [view-bugs]: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&component=Deltacloud&product=Virtualization%20Tools&classification=Other + [new-bug]: https://bugzilla.redhat.com/enter_bug.cgi?product=Virtualization%20Tools&component=Deltacloud + %li + %h3 Patches + :markdown + Patches are very welcome. Please send them to the [development list][5]. Patches should be generated with [`git` `format-patch`][6] and sent to the list with [`git` `send-email`][7]. + + [5]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel + [6]: http://kernel.org/pub/software/scm/git/docs/git-format-patch.html + [7]: http://kernel.org/pub/software/scm/git/docs/git-send-email.html diff --git a/deltacloud.org/content/_readme.haml b/deltacloud.org/content/_readme.haml new file mode 100644 index 0000000..7a93aa7 --- /dev/null +++ b/deltacloud.org/content/_readme.haml @@ -0,0 +1,6 @@ +--- +filter: + - haml + - markdown +--- += File.open('../README').read diff --git a/deltacloud.org/content/contribute.haml b/deltacloud.org/content/contribute.haml index 0e74426..cb97d23 100644 --- a/deltacloud.org/content/contribute.haml +++ b/deltacloud.org/content/contribute.haml @@ -2,37 +2,27 @@ title: Deltacloud - Contribute extension: html filter: - - erb - - markdown + - haml - outline + - erb --- -<toc numbering="off" toc_style="ul" toc_range="h2-h3" /> - -Contribute -========== - -All development of Deltacloud takes place in the open. Communication is run through the mailing list and all source code changes are tracked publicly. We have two lists, one for [user questions][1], and one for [development discussions and patches][2]. - -[1]: https://fedorahosted.org/mailman/listinfo/deltacloud-users -[2]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel - -You can also join us on the Freenode IRC channel #deltacloud. +/ FIXME: This is a temporary workaround. +/ +/ The new design has <h3> headers in this place, which breaks the Outline +/ filter (that generates TOC). +/ +/ Until we change the layout to something else, we have to: +/ 1. build the README part +/ 2. generate TOC for it +/ 3. add the Contribute part +/ in that order. -Deltacloud developers are generally available on the IRC channel, but if you do not get a response to a posted question on the IRC channel please ask on the [user mailing list][3]. - -[3]: https://fedorahosted.org/mailman/listinfo/deltacloud-users - -We track bugs in [Red Hat Bugzilla][4]. You can [view open bugs][view-bugs] or [file a new one][new-bug] there. - -[4]: https://bugzilla.redhat.com/ -[view-bugs]: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&component=Deltacloud&product=Virtualization%20Tools&classification=Other -[new-bug]: https://bugzilla.redhat.com/enter_bug.cgi?product=Virtualization%20Tools&component=Deltacloud - -Patches are very welcome. Please send them to the [development list][5]. Patches should be generated with [`git` `format-patch`][6] and sent to the list with [`git` `send-email`][7]. - -[5]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel -[6]: http://kernel.org/pub/software/scm/git/docs/git-format-patch.html -[7]: http://kernel.org/pub/software/scm/git/docs/git-send-email.html +<toc numbering="off" toc_style="ul" toc_range="h2-h3" /> +/ guideline about contributing to the project +/ must be rendered *after* TOC is generated +:plain + <%= render(:partial => "contribute") %> -<%= File.open('../README').read %> +/ the README file converted from Markdown to HTML += render(:partial => "readme") -- 1.6.6.1 _______________________________________________ deltacloud-devel mailing list [email protected] https://fedorahosted.org/mailman/listinfo/deltacloud-devel
