Contribution routes to Apache Ignite - updating the website

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Contribution routes to Apache Ignite - updating the website

Raul Kripalani
The "Start Contributing" section is somewhat unclear and outdated IMHO.
Unfortunately since this is not Wiki, I cannot modify it (where is the
site's source?).

The section should indicate there are two routes to contribution:

* Sending a patch.
* Sending a Github Pull Request.

*Sending a patch:*

There are multiple ways to do this, but the easiest is to clone the ASF or
Github repo and use git-format-patch to generate a patch.

I don't understand the current verbiage about creating a branch with the
ticket number – this may be relevant (for clarity purposes, not for
technical reasons) if the user is sending a PR via Github. But since this
contribution route does not entail pushing commits anywhere, the branch
name should not be relevant.

*Sending a Github Pull Request:*

Steps I propose (roughly):

1. Fork the ASF mirror repo apache/ignite into your Github account.
2. In your workstation, clone the fork you've just created.
3. Create a branch from master or from a release (if you're submitting a
hotfix), with name equal to the ticket number in lowercase and with a
hyphen.
4. Work away!
5. When you're ready to submit the pull request, open a Pull Request
against apache/ignite and select the target branch (master or release –
usually Github will populate this for you automatically).
6. Start the pull request title with the ticket number as given by JIRA
keeping capitalisation (IGNITE-nnnn). This will allow the ASF Github bot to
match the pull request against the appropriate ticket. As a result, it will
add a comment and it will send an email to the dev@ mailing list.
7. In the JIRA ticket, you may edit the ticket and tick the "Patch" option
to signal that there's a patch available.

Hope this helps,

*Raúl Kripalani*
Apache Camel PMC Member & Committer | Enterprise Architect, Open Source
Integration specialist
http://about.me/raulkripalani | http://www.linkedin.com/in/raulkripalani
http://blog.raulkr.net | twitter: @raulvk
Reply | Threaded
Open this post in threaded view
|

Re: Contribution routes to Apache Ignite - updating the website

Branko Čibej
On 25.08.2015 13:09, Raul Kripalani wrote:
> The "Start Contributing" section is somewhat unclear and outdated IMHO.
> Unfortunately since this is not Wiki, I cannot modify it (where is the
> site's source?).


The site is, of course, in Subversion at
https://svn.apache.org/repos/asf/ignite/site/trunk. Any changes are
automatically published on commit via SVNPubSub.

-- Brane
Reply | Threaded
Open this post in threaded view
|

Re: Contribution routes to Apache Ignite - updating the website

Raul Kripalani-2
On Tue, Aug 25, 2015 at 12:16 PM, Branko Čibej <[hidden email]> wrote:

> The site is, of course, in Subversion at
> https://svn.apache.org/repos/asf/ignite/site/trunk. Any changes are
> automatically published on commit via SVNPubSub.
>

Cool, thanks. I didn't know that.
In the Camel we use a Wiki to publish the main site, and AMQ works with a
wiki too.

*Raúl Kripalani*
Apache Camel PMC Member & Committer | Enterprise Architect, Open Source
Integration specialist
http://about.me/raulkripalani | http://www.linkedin.com/in/raulkripalani
http://blog.raulkr.net | twitter: @raulvk
Reply | Threaded
Open this post in threaded view
|

Re: Contribution routes to Apache Ignite - updating the website

Roman Shaposhnik
On Tue, Aug 25, 2015 at 4:21 AM, Raul Kripalani <[hidden email]> wrote:

> On Tue, Aug 25, 2015 at 12:16 PM, Branko Čibej <[hidden email]> wrote:
>
>> The site is, of course, in Subversion at
>> https://svn.apache.org/repos/asf/ignite/site/trunk. Any changes are
>> automatically published on commit via SVNPubSub.
>>
>
> Cool, thanks. I didn't know that.
> In the Camel we use a Wiki to publish the main site, and AMQ works with a
> wiki too.

Can you elaborate more on how wiki is used to manage a website?

Thanks,
Roman.
Reply | Threaded
Open this post in threaded view
|

Re: Contribution routes to Apache Ignite - updating the website

Raul Kripalani
On Tue, Aug 25, 2015 at 4:10 PM, Roman Shaposhnik <[hidden email]>
wrote:

> Can you elaborate more on how wiki is used to manage a website?
>

I wasn't a PMC member when the integration was set up, but I think the idea
is to allow contributors to amend and enhance the documentation, by
leveraging the Confluence WYSIWYG editor. Also, because (1) our project is
extremely modular (200+), (2) people contribute components, and (3) each
component has its own doc page, this setup is useful for allowing
contributors to write and maintain the documentation of the components they
master on a continuous basis.

We have a job in ci.apache.org buildbot which exports the wiki pages as
HTML and commits them to the CMS SVN:
https://ci.apache.org/builders/camel-site-production.

Regards,

*Raúl Kripalani*
Apache Camel PMC Member & Committer | Enterprise Architect, Open Source
Integration specialist
http://about.me/raulkripalani | http://www.linkedin.com/in/raulkripalani
http://blog.raulkr.net | twitter: @raulvk