All,

As you probably all know, we have a website at Apache:
https://brooklyn.incubator.apache.org/

It's now at the point where there can be a standard documented
workflow for proposing and making updates to the website. So far I've
been the only person working on the website, pushing directly to
publish (commit-then-review). As of now I'll cease doing this, and we
will all use the same review-then-commit process that we are using for
the main source code.

Below is a summary of the process.


CONTRIBUTORS

The website is written using Markdown. Jekyll is used to turn the
Markdown into HTML (but you don't need to know anything about that.)

The workflow is identical to working on the main source code[1], with
the exception that the repository has a different name -
https://github.com/apache/incubator-brooklyn-site. You can fork this
repository and make pull requests to propose changes.

[1] https://brooklyn.incubator.apache.org/community/how-to-contribute.html

Furthermore, thanks to a nifty bit of GitHub integration (shamelessly
cloned from jclouds!), most pages on the public website have an "Edit
this page" button at the bottom. If you are just making changes to a
single page, this is the simplest way to do it - hit the button, make
your changes in GitHub's integrated editor, and click a couple of
buttons to make a pull request from it.

There's some more information here:
https://brooklyn.incubator.apache.org/community/how-to-contribute-docs.html


COMMITTERS

Review and handle pull requests exactly as you would do for the main
source. Everything is the same except for the repository name -
incubator-brooklyn-site.

There is an extra step to turn the Markdown source into HTML and
publish it. Setting up Jekyll and publishing is described in the
README.md file in the repository[2]

[2] https://github.com/apache/incubator-brooklyn-site/blob/master/README.md


I hope this makes sense. Please try it out and let us know if there's
any problem.

Richard.

Reply via email to