Ignite Benchmarking page on readme.io

[alexzaitzev]

Hi, guys.

Issue[1] stated that we have not any information about Apache Ignite benchmarking on our site https://apacheignite.readme.io. I want to add such a page, but I can’t find appropriate section for it. I suggest to make new section named ‘Tests and Benchmarking’ and put all information about benchmaring in section page ‘Perfomance Tests’

Thoughts?

[1] https://issues.apache.org/jira/browse/IGNITE-6278

[Anton Vinogradov]

Aleksei,

Good idea.
Could you please prepare page in MD format and attach link to branch
containing it to the issue to review before publication?



On Thu, Sep 7, 2017 at 1:45 PM, Aleksei Zaitsev <[hidden email]>
wrote:

> Hi, guys.
>
> Issue[1] stated that we have not any information about Apache Ignite
> benchmarking on our site https://apacheignite.readme.io. I want to add
> such a page, but I can’t find appropriate section for it. I suggest to make
> new section named ‘Tests and Benchmarking’ and put all information about
> benchmaring in section page ‘Perfomance Tests’
>
> Thoughts?
>
> [1] https://issues.apache.org/jira/browse/IGNITE-6278
>

[dsetrakyan]

Actually, it can be contributed directly to readme.io. Alexey, I just sent
you an invite.

You can create a new page for benchmarking and make it invisible for now,
while you are working on it. If you need us to review it, please send a
direct link to it here.

D.

On Thu, Sep 7, 2017 at 8:26 AM, Anton Vinogradov <[hidden email]>
wrote:

> Aleksei,
>
> Good idea.
> Could you please prepare page in MD format and attach link to branch
> containing it to the issue to review before publication?
>
>
>
> On Thu, Sep 7, 2017 at 1:45 PM, Aleksei Zaitsev <[hidden email]>
> wrote:
>
> > Hi, guys.
> >
> > Issue[1] stated that we have not any information about Apache Ignite
> > benchmarking on our site https://apacheignite.readme.io. I want to add
> > such a page, but I can’t find appropriate section for it. I suggest to
> make
> > new section named ‘Tests and Benchmarking’ and put all information about
> > benchmaring in section page ‘Perfomance Tests’
> >
> > Thoughts?
> >
> > [1] https://issues.apache.org/jira/browse/IGNITE-6278
> >
>

[alexzaitzev]

Thanks. Here is a direct link on the new page about Ignite Benchmarking(hidden for now): https://apacheignite.readme.io/v2.1/docs/perfomance-tests. Please review.
Mostly it was aggregated from the information in the repo

07.09.2017, 20:57, "Dmitriy Setrakyan" <[hidden email]>:

> Actually, it can be contributed directly to readme.io. Alexey, I just sent you an invite.
>
> You can create a new page for benchmarking and make it invisible for now, while you are working on it. If you need us to review it, please send a direct link to it here.
>
> D.
>
> On Thu, Sep 7, 2017 at 8:26 AM, Anton Vinogradov <[hidden email]> wrote:
>> Aleksei,
>>
>> Good idea.
>> Could you please prepare page in MD format and attach link to branch
>> containing it to the issue to review before publication?
>>
>> On Thu, Sep 7, 2017 at 1:45 PM, Aleksei Zaitsev <[hidden email]>
>> wrote:
>>
>>> Hi, guys.
>>>
>>> Issue[1] stated that we have not any information about Apache Ignite
>>> benchmarking on our site https://apacheignite.readme.io. I want to add
>>> such a page, but I can’t find appropriate section for it. I suggest to make
>>> new section named ‘Tests and Benchmarking’ and put all information about
>>> benchmaring in section page ‘Perfomance Tests’
>>>
>>> Thoughts?
>>>
>>> [1] https://issues.apache.org/jira/browse/IGNITE-6278
>>>

[dmagda]

I’ve done the primarily review and rename the page address. That’s it:
https://apacheignite.readme.io/docs/perfomance-benchmarking <https://apacheignite.readme.io/docs/perfomance-benchmarking>

Prachi, please do the final review. The page is already online.

—
Denis

> On Sep 8, 2017, at 10:40 AM, Aleksei Zaitsev <[hidden email]> wrote:
>
> Thanks. Here is a direct link on the new page about Ignite Benchmarking(hidden for now): https://apacheignite.readme.io/v2.1/docs/perfomance-tests. Please review.
> Mostly it was aggregated from the information in the repo
>
> 07.09.2017, 20:57, "Dmitriy Setrakyan" <[hidden email]>:
>> Actually, it can be contributed directly to readme.io. Alexey, I just sent you an invite.
>>
>> You can create a new page for benchmarking and make it invisible for now, while you are working on it. If you need us to review it, please send a direct link to it here.
>>
>> D.
>>
>> On Thu, Sep 7, 2017 at 8:26 AM, Anton Vinogradov <[hidden email]> wrote:
>>> Aleksei,
>>>
>>> Good idea.
>>> Could you please prepare page in MD format and attach link to branch
>>> containing it to the issue to review before publication?
>>>
>>> On Thu, Sep 7, 2017 at 1:45 PM, Aleksei Zaitsev <[hidden email]>
>>> wrote:
>>>
>>>> Hi, guys.
>>>>
>>>> Issue[1] stated that we have not any information about Apache Ignite
>>>> benchmarking on our site https://apacheignite.readme.io. I want to add
>>>> such a page, but I can’t find appropriate section for it. I suggest to make
>>>> new section named ‘Tests and Benchmarking’ and put all information about
>>>> benchmaring in section page ‘Perfomance Tests’
>>>>
>>>> Thoughts?
>>>>
>>>> [1] https://issues.apache.org/jira/browse/IGNITE-6278
>>>>

[dsetrakyan]

Several comments:

   1. I would place this page directly under the top Basic Concepts section
   2. I would rename the link to Benchmarking (performance is assumed)
   3. I would add a few benchmark runs with examples graphs there

D.

On Mon, Sep 11, 2017 at 5:03 PM, Denis Magda <[hidden email]> wrote:

> I’ve done the primarily review and rename the page address. That’s it:
> https://apacheignite.readme.io/docs/perfomance-benchmarking
>
> Prachi, please do the final review. The page is already online.
>
> —
> Denis
>
> On Sep 8, 2017, at 10:40 AM, Aleksei Zaitsev <[hidden email]>
> wrote:
>
> Thanks. Here is a direct link on the new page about Ignite
> Benchmarking(hidden for now): https://apacheignite.readme.
> io/v2.1/docs/perfomance-tests. Please review.
> Mostly it was aggregated from the information in the repo
>
> 07.09.2017, 20:57, "Dmitriy Setrakyan" <[hidden email]>:
>
> Actually, it can be contributed directly to readme.io. Alexey, I just
> sent you an invite.
>
> You can create a new page for benchmarking and make it invisible for now,
> while you are working on it. If you need us to review it, please send a
> direct link to it here.
>
> D.
>
> On Thu, Sep 7, 2017 at 8:26 AM, Anton Vinogradov <[hidden email]>
> wrote:
>
> Aleksei,
>
> Good idea.
> Could you please prepare page in MD format and attach link to branch
> containing it to the issue to review before publication?
>
> On Thu, Sep 7, 2017 at 1:45 PM, Aleksei Zaitsev <[hidden email]>
> wrote:
>
> Hi, guys.
>
> Issue[1] stated that we have not any information about Apache Ignite
> benchmarking on our site https://apacheignite.readme.io. I want to add
> such a page, but I can’t find appropriate section for it. I suggest to make
> new section named ‘Tests and Benchmarking’ and put all information about
> benchmaring in section page ‘Perfomance Tests’
>
> Thoughts?
>
> [1] https://issues.apache.org/jira/browse/IGNITE-6278
>
>
>

[dmagda]

1. It’s fine to have it under the current section that will include testing related documentation proposed by Yakov in other discussion thread.

2. That’s easy and makes total sense. Renamed.

3. Mikhail could you add this?

—
Denis

> On Sep 11, 2017, at 6:01 PM, Dmitriy Setrakyan <[hidden email]> wrote:
>
> Several comments:
> I would place this page directly under the top Basic Concepts section
> I would rename the link to Benchmarking (performance is assumed)
> I would add a few benchmark runs with examples graphs there
> D.
>
> On Mon, Sep 11, 2017 at 5:03 PM, Denis Magda <[hidden email] <mailto:[hidden email]>> wrote:
> I’ve done the primarily review and rename the page address. That’s it:
> https://apacheignite.readme.io/docs/perfomance-benchmarking <https://apacheignite.readme.io/docs/perfomance-benchmarking>
>
> Prachi, please do the final review. The page is already online.
>
> —
> Denis
>
>> On Sep 8, 2017, at 10:40 AM, Aleksei Zaitsev <[hidden email] <mailto:[hidden email]>> wrote:
>>
>> Thanks. Here is a direct link on the new page about Ignite Benchmarking(hidden for now): https://apacheignite.readme.io/v2.1/docs/perfomance-tests <https://apacheignite.readme.io/v2.1/docs/perfomance-tests>. Please review.
>> Mostly it was aggregated from the information in the repo
>>
>> 07.09.2017, 20:57, "Dmitriy Setrakyan" <[hidden email] <mailto:[hidden email]>>:
>>> Actually, it can be contributed directly to readme.io <http://readme.io/>. Alexey, I just sent you an invite.
>>>
>>> You can create a new page for benchmarking and make it invisible for now, while you are working on it. If you need us to review it, please send a direct link to it here.
>>>
>>> D.
>>>
>>> On Thu, Sep 7, 2017 at 8:26 AM, Anton Vinogradov <[hidden email] <mailto:[hidden email]>> wrote:
>>>> Aleksei,
>>>>
>>>> Good idea.
>>>> Could you please prepare page in MD format and attach link to branch
>>>> containing it to the issue to review before publication?
>>>>
>>>> On Thu, Sep 7, 2017 at 1:45 PM, Aleksei Zaitsev <[hidden email] <mailto:[hidden email]>>
>>>> wrote:
>>>>
>>>>> Hi, guys.
>>>>>
>>>>> Issue[1] stated that we have not any information about Apache Ignite
>>>>> benchmarking on our site https://apacheignite.readme.io <https://apacheignite.readme.io/>. I want to add
>>>>> such a page, but I can’t find appropriate section for it. I suggest to make
>>>>> new section named ‘Tests and Benchmarking’ and put all information about
>>>>> benchmaring in section page ‘Perfomance Tests’
>>>>>
>>>>> Thoughts?
>>>>>
>>>>> [1] https://issues.apache.org/jira/browse/IGNITE-6278 <https://issues.apache.org/jira/browse/IGNITE-6278>
>>>>>
>
>

[dsetrakyan]

On Mon, Sep 11, 2017 at 6:10 PM, Denis Magda <[hidden email]> wrote:

> 1. It’s fine to have it under the current section that will include
> testing related documentation proposed by Yakov in other discussion thread.
>

I think we should avoid having 1-page sections. They look bad. Also,
benchmarking is a very common topic during evaluation process and deserves
a spot up top. I would still place it under Basic Concepts for now. You can
always move it to a separate section once we have more content.