You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ignite.apache.org by Denis Magda <dm...@apache.org> on 2021/08/04 09:40:38 UTC
Re: [DISCUSSION] Documentation feedback button
Nikita,
We created a bugyard account for the Ignite community. I'm suggesting using
a shared account bound to 'dev@ignite.apache.org'. That will allow everyone
on the dev list to receive and process documentation feedback.
https://svn.apache.org/repos/private/pmc/ignite/credentials/bugyard.io
Mauricio will add the button to the website shortly. I'll let you update
the documentation process.
--
Denis
-
Denis
On Tue, Jul 27, 2021 at 5:24 PM Nikita Safonov <vl...@gmail.com>
wrote:
> Hello Igniters,
>
> I would like to proceed with implementing the feedback service for the
> Ignite documentation website.
> If nobody objects, let's start the work.
> The details are described here:
> https://issues.apache.org/jira/browse/IGNITE-15198
>
> With best regards,
> Nikita
>
> ср, 17 мар. 2021 г. в 15:50, Mauricio Stekl <ma...@stekl.org>:
>
> > Hi,
> > I agree with Nikita, it would be a very simple way of getting feedback to
> > improve the documentation.
> > This tool in particular is quite easy to integrate into the online docs
> > template.
> >
> > Best,
> > Mauricio
> >
> >
> >
> >
> >
> > On Tue, Mar 16, 2021 at 4:46 PM Denis Magda <dm...@apache.org> wrote:
> >
> > > Nikita, thanks for starting the conversation. I'll just cast my vote
> for
> > > the bugyard.io for its ability to select and comment on a specific
> > > problematic point on a documentation page (a paragraph, sentence,
> > picture,
> > > code snippet, etc.). It makes it trivial to share feedback and then
> it's
> > > easy to process it on the other side. Those who'd like to experience
> it,
> > > click the "Documentation Feedback" button on the GridGain docs:
> > > https://www.gridgain.com/docs/latest/getting-started/what-is-gridgain
> > >
> > > -
> > > Denis
> > >
> > >
> > > On Tue, Mar 16, 2021 at 3:14 PM Никита Сафонов <
> > vlasovpavel2011@gmail.com>
> > > wrote:
> > >
> > > > Hello Igniters,
> > > >
> > > > I would like to propose an enhancement that can significantly improve
> > the
> > > > quality of our documentation.
> > > >
> > > > I suggest adding a feedback button (let’s call it a «Documentation
> > > > feedback» button) to the web site documentation pages so everyone
> could
> > > > leave a comment to what is already published.
> > > >
> > > > The feedback may refer to the Ignite documentation in general or to a
> > > > particular section, paragraph, or even term or value.
> > > >
> > > > I do believe that we would harvest dozens and hundreds of ideas,
> > > > suggestions, and observations.
> > > >
> > > > I would also suggest using bugyard.io as a solid service for
> gathering
> > > > feedback (I’m quite familiar with it, it is easy to implement, use,
> and
> > > > maintain).
> > > >
> > > > So folks, what do you think of this?
> > > >
> > > > With best regards,
> > > > Nikita
> > > >
> > >
> >
>
Re: [DISCUSSION] Documentation feedback button
Posted by Ivan Pavlukhina <vo...@gmail.com>.
Denis,
I still feel that redirecting yet another notification source to dev list without discussion with the Community is not right way to go. Especially when significant efforts were spent to keep the list clean. I will start a discussion.
> On 6 Aug 2021, at 22:46, Mauricio Stekl <ma...@stekl.org> wrote:
>
> Hi,
> Just ss a heads up, I added the button to the online docs template and
> rebuilt the latest version & 3.0.0a docs.
> Please let me know if you have any questions or suggestions.
>
>
> Best,
> Mauricio Stekl
>
>
>
>
>> On Fri, Aug 6, 2021 at 12:17 PM Denis Magda <dm...@apache.org> wrote:
>>
>> There is no such a way. Notifications are always sent to an email address
>> used by a bugyard account. Anyway, I don’t see any harm in this - usually
>> you’ll get a 1-2 notifications a week. Plus, many more community members
>> prepare documentation for features they build these days, thus, it’s good
>> to receive feedback for your work.
>>
>>
>>> On Friday, August 6, 2021, Ivan Pavlukhin <vo...@gmail.com> wrote:
>>>
>>> Is there an easy way to subscribe personally for such notifications? I
>>> forsee complaints that the majority of developers are not interested
>>> in documentation feedback notifications.
>>>
>>> 2021-08-04 12:40 GMT+03:00, Denis Magda <dm...@apache.org>:
>>>> Nikita,
>>>>
>>>> We created a bugyard account for the Ignite community. I'm suggesting
>>> using
>>>> a shared account bound to 'dev@ignite.apache.org'. That will allow
>>> everyone
>>>> on the dev list to receive and process documentation feedback.
>>>> https://svn.apache.org/repos/private/pmc/ignite/credentials/bugyard.io
>>>>
>>>> Mauricio will add the button to the website shortly. I'll let you
>> update
>>>> the documentation process.
>>>>
>>>> --
>>>> Denis
>>>>
>>>>
>>>> -
>>>> Denis
>>>>
>>>> On Tue, Jul 27, 2021 at 5:24 PM Nikita Safonov <
>>> vlasovpavel2011@gmail.com>
>>>> wrote:
>>>>
>>>>> Hello Igniters,
>>>>>
>>>>> I would like to proceed with implementing the feedback service for the
>>>>> Ignite documentation website.
>>>>> If nobody objects, let's start the work.
>>>>> The details are described here:
>>>>> https://issues.apache.org/jira/browse/IGNITE-15198
>>>>>
>>>>> With best regards,
>>>>> Nikita
>>>>>
>>>>> ср, 17 мар. 2021 г. в 15:50, Mauricio Stekl <ma...@stekl.org>:
>>>>>
>>>>>> Hi,
>>>>>> I agree with Nikita, it would be a very simple way of getting
>> feedback
>>>>>> to
>>>>>> improve the documentation.
>>>>>> This tool in particular is quite easy to integrate into the online
>>> docs
>>>>>> template.
>>>>>>
>>>>>> Best,
>>>>>> Mauricio
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>> On Tue, Mar 16, 2021 at 4:46 PM Denis Magda <dm...@apache.org>
>>> wrote:
>>>>>>
>>>>>>> Nikita, thanks for starting the conversation. I'll just cast my
>> vote
>>>>> for
>>>>>>> the bugyard.io for its ability to select and comment on a
>> specific
>>>>>>> problematic point on a documentation page (a paragraph, sentence,
>>>>>> picture,
>>>>>>> code snippet, etc.). It makes it trivial to share feedback and
>> then
>>>>> it's
>>>>>>> easy to process it on the other side. Those who'd like to
>> experience
>>>>> it,
>>>>>>> click the "Documentation Feedback" button on the GridGain docs:
>>>>>>> https://www.gridgain.com/docs/latest/getting-started/what-
>>> is-gridgain
>>>>>>>
>>>>>>> -
>>>>>>> Denis
>>>>>>>
>>>>>>>
>>>>>>> On Tue, Mar 16, 2021 at 3:14 PM Никита Сафонов <
>>>>>> vlasovpavel2011@gmail.com>
>>>>>>> wrote:
>>>>>>>
>>>>>>>> Hello Igniters,
>>>>>>>>
>>>>>>>> I would like to propose an enhancement that can significantly
>>>>>>>> improve
>>>>>> the
>>>>>>>> quality of our documentation.
>>>>>>>>
>>>>>>>> I suggest adding a feedback button (let’s call it a
>> «Documentation
>>>>>>>> feedback» button) to the web site documentation pages so
>> everyone
>>>>> could
>>>>>>>> leave a comment to what is already published.
>>>>>>>>
>>>>>>>> The feedback may refer to the Ignite documentation in general or
>>> to
>>>>>>>> a
>>>>>>>> particular section, paragraph, or even term or value.
>>>>>>>>
>>>>>>>> I do believe that we would harvest dozens and hundreds of ideas,
>>>>>>>> suggestions, and observations.
>>>>>>>>
>>>>>>>> I would also suggest using bugyard.io as a solid service for
>>>>> gathering
>>>>>>>> feedback (I’m quite familiar with it, it is easy to implement,
>>> use,
>>>>> and
>>>>>>>> maintain).
>>>>>>>>
>>>>>>>> So folks, what do you think of this?
>>>>>>>>
>>>>>>>> With best regards,
>>>>>>>> Nikita
>>>>>>>>
>>>>>>>
>>>>>>
>>>>>
>>>>
>>>
>>>
>>> --
>>>
>>> Best regards,
>>> Ivan Pavlukhin
>>>
>>
>>
>> --
>> -
>> Denis
>>
Re: [DISCUSSION] Documentation feedback button
Posted by Mauricio Stekl <ma...@stekl.org>.
Hi,
Just ss a heads up, I added the button to the online docs template and
rebuilt the latest version & 3.0.0a docs.
Please let me know if you have any questions or suggestions.
Best,
Mauricio Stekl
On Fri, Aug 6, 2021 at 12:17 PM Denis Magda <dm...@apache.org> wrote:
> There is no such a way. Notifications are always sent to an email address
> used by a bugyard account. Anyway, I don’t see any harm in this - usually
> you’ll get a 1-2 notifications a week. Plus, many more community members
> prepare documentation for features they build these days, thus, it’s good
> to receive feedback for your work.
>
>
> On Friday, August 6, 2021, Ivan Pavlukhin <vo...@gmail.com> wrote:
>
> > Is there an easy way to subscribe personally for such notifications? I
> > forsee complaints that the majority of developers are not interested
> > in documentation feedback notifications.
> >
> > 2021-08-04 12:40 GMT+03:00, Denis Magda <dm...@apache.org>:
> > > Nikita,
> > >
> > > We created a bugyard account for the Ignite community. I'm suggesting
> > using
> > > a shared account bound to 'dev@ignite.apache.org'. That will allow
> > everyone
> > > on the dev list to receive and process documentation feedback.
> > > https://svn.apache.org/repos/private/pmc/ignite/credentials/bugyard.io
> > >
> > > Mauricio will add the button to the website shortly. I'll let you
> update
> > > the documentation process.
> > >
> > > --
> > > Denis
> > >
> > >
> > > -
> > > Denis
> > >
> > > On Tue, Jul 27, 2021 at 5:24 PM Nikita Safonov <
> > vlasovpavel2011@gmail.com>
> > > wrote:
> > >
> > >> Hello Igniters,
> > >>
> > >> I would like to proceed with implementing the feedback service for the
> > >> Ignite documentation website.
> > >> If nobody objects, let's start the work.
> > >> The details are described here:
> > >> https://issues.apache.org/jira/browse/IGNITE-15198
> > >>
> > >> With best regards,
> > >> Nikita
> > >>
> > >> ср, 17 мар. 2021 г. в 15:50, Mauricio Stekl <ma...@stekl.org>:
> > >>
> > >> > Hi,
> > >> > I agree with Nikita, it would be a very simple way of getting
> feedback
> > >> > to
> > >> > improve the documentation.
> > >> > This tool in particular is quite easy to integrate into the online
> > docs
> > >> > template.
> > >> >
> > >> > Best,
> > >> > Mauricio
> > >> >
> > >> >
> > >> >
> > >> >
> > >> >
> > >> > On Tue, Mar 16, 2021 at 4:46 PM Denis Magda <dm...@apache.org>
> > wrote:
> > >> >
> > >> > > Nikita, thanks for starting the conversation. I'll just cast my
> vote
> > >> for
> > >> > > the bugyard.io for its ability to select and comment on a
> specific
> > >> > > problematic point on a documentation page (a paragraph, sentence,
> > >> > picture,
> > >> > > code snippet, etc.). It makes it trivial to share feedback and
> then
> > >> it's
> > >> > > easy to process it on the other side. Those who'd like to
> experience
> > >> it,
> > >> > > click the "Documentation Feedback" button on the GridGain docs:
> > >> > > https://www.gridgain.com/docs/latest/getting-started/what-
> > is-gridgain
> > >> > >
> > >> > > -
> > >> > > Denis
> > >> > >
> > >> > >
> > >> > > On Tue, Mar 16, 2021 at 3:14 PM Никита Сафонов <
> > >> > vlasovpavel2011@gmail.com>
> > >> > > wrote:
> > >> > >
> > >> > > > Hello Igniters,
> > >> > > >
> > >> > > > I would like to propose an enhancement that can significantly
> > >> > > > improve
> > >> > the
> > >> > > > quality of our documentation.
> > >> > > >
> > >> > > > I suggest adding a feedback button (let’s call it a
> «Documentation
> > >> > > > feedback» button) to the web site documentation pages so
> everyone
> > >> could
> > >> > > > leave a comment to what is already published.
> > >> > > >
> > >> > > > The feedback may refer to the Ignite documentation in general or
> > to
> > >> > > > a
> > >> > > > particular section, paragraph, or even term or value.
> > >> > > >
> > >> > > > I do believe that we would harvest dozens and hundreds of ideas,
> > >> > > > suggestions, and observations.
> > >> > > >
> > >> > > > I would also suggest using bugyard.io as a solid service for
> > >> gathering
> > >> > > > feedback (I’m quite familiar with it, it is easy to implement,
> > use,
> > >> and
> > >> > > > maintain).
> > >> > > >
> > >> > > > So folks, what do you think of this?
> > >> > > >
> > >> > > > With best regards,
> > >> > > > Nikita
> > >> > > >
> > >> > >
> > >> >
> > >>
> > >
> >
> >
> > --
> >
> > Best regards,
> > Ivan Pavlukhin
> >
>
>
> --
> -
> Denis
>
Re: [DISCUSSION] Documentation feedback button
Posted by Denis Magda <dm...@apache.org>.
There is no such a way. Notifications are always sent to an email address
used by a bugyard account. Anyway, I don’t see any harm in this - usually
you’ll get a 1-2 notifications a week. Plus, many more community members
prepare documentation for features they build these days, thus, it’s good
to receive feedback for your work.
On Friday, August 6, 2021, Ivan Pavlukhin <vo...@gmail.com> wrote:
> Is there an easy way to subscribe personally for such notifications? I
> forsee complaints that the majority of developers are not interested
> in documentation feedback notifications.
>
> 2021-08-04 12:40 GMT+03:00, Denis Magda <dm...@apache.org>:
> > Nikita,
> >
> > We created a bugyard account for the Ignite community. I'm suggesting
> using
> > a shared account bound to 'dev@ignite.apache.org'. That will allow
> everyone
> > on the dev list to receive and process documentation feedback.
> > https://svn.apache.org/repos/private/pmc/ignite/credentials/bugyard.io
> >
> > Mauricio will add the button to the website shortly. I'll let you update
> > the documentation process.
> >
> > --
> > Denis
> >
> >
> > -
> > Denis
> >
> > On Tue, Jul 27, 2021 at 5:24 PM Nikita Safonov <
> vlasovpavel2011@gmail.com>
> > wrote:
> >
> >> Hello Igniters,
> >>
> >> I would like to proceed with implementing the feedback service for the
> >> Ignite documentation website.
> >> If nobody objects, let's start the work.
> >> The details are described here:
> >> https://issues.apache.org/jira/browse/IGNITE-15198
> >>
> >> With best regards,
> >> Nikita
> >>
> >> ср, 17 мар. 2021 г. в 15:50, Mauricio Stekl <ma...@stekl.org>:
> >>
> >> > Hi,
> >> > I agree with Nikita, it would be a very simple way of getting feedback
> >> > to
> >> > improve the documentation.
> >> > This tool in particular is quite easy to integrate into the online
> docs
> >> > template.
> >> >
> >> > Best,
> >> > Mauricio
> >> >
> >> >
> >> >
> >> >
> >> >
> >> > On Tue, Mar 16, 2021 at 4:46 PM Denis Magda <dm...@apache.org>
> wrote:
> >> >
> >> > > Nikita, thanks for starting the conversation. I'll just cast my vote
> >> for
> >> > > the bugyard.io for its ability to select and comment on a specific
> >> > > problematic point on a documentation page (a paragraph, sentence,
> >> > picture,
> >> > > code snippet, etc.). It makes it trivial to share feedback and then
> >> it's
> >> > > easy to process it on the other side. Those who'd like to experience
> >> it,
> >> > > click the "Documentation Feedback" button on the GridGain docs:
> >> > > https://www.gridgain.com/docs/latest/getting-started/what-
> is-gridgain
> >> > >
> >> > > -
> >> > > Denis
> >> > >
> >> > >
> >> > > On Tue, Mar 16, 2021 at 3:14 PM Никита Сафонов <
> >> > vlasovpavel2011@gmail.com>
> >> > > wrote:
> >> > >
> >> > > > Hello Igniters,
> >> > > >
> >> > > > I would like to propose an enhancement that can significantly
> >> > > > improve
> >> > the
> >> > > > quality of our documentation.
> >> > > >
> >> > > > I suggest adding a feedback button (let’s call it a «Documentation
> >> > > > feedback» button) to the web site documentation pages so everyone
> >> could
> >> > > > leave a comment to what is already published.
> >> > > >
> >> > > > The feedback may refer to the Ignite documentation in general or
> to
> >> > > > a
> >> > > > particular section, paragraph, or even term or value.
> >> > > >
> >> > > > I do believe that we would harvest dozens and hundreds of ideas,
> >> > > > suggestions, and observations.
> >> > > >
> >> > > > I would also suggest using bugyard.io as a solid service for
> >> gathering
> >> > > > feedback (I’m quite familiar with it, it is easy to implement,
> use,
> >> and
> >> > > > maintain).
> >> > > >
> >> > > > So folks, what do you think of this?
> >> > > >
> >> > > > With best regards,
> >> > > > Nikita
> >> > > >
> >> > >
> >> >
> >>
> >
>
>
> --
>
> Best regards,
> Ivan Pavlukhin
>
--
-
Denis
Re: [DISCUSSION] Documentation feedback button
Posted by Ivan Pavlukhin <vo...@gmail.com>.
Is there an easy way to subscribe personally for such notifications? I
forsee complaints that the majority of developers are not interested
in documentation feedback notifications.
2021-08-04 12:40 GMT+03:00, Denis Magda <dm...@apache.org>:
> Nikita,
>
> We created a bugyard account for the Ignite community. I'm suggesting using
> a shared account bound to 'dev@ignite.apache.org'. That will allow everyone
> on the dev list to receive and process documentation feedback.
> https://svn.apache.org/repos/private/pmc/ignite/credentials/bugyard.io
>
> Mauricio will add the button to the website shortly. I'll let you update
> the documentation process.
>
> --
> Denis
>
>
> -
> Denis
>
> On Tue, Jul 27, 2021 at 5:24 PM Nikita Safonov <vl...@gmail.com>
> wrote:
>
>> Hello Igniters,
>>
>> I would like to proceed with implementing the feedback service for the
>> Ignite documentation website.
>> If nobody objects, let's start the work.
>> The details are described here:
>> https://issues.apache.org/jira/browse/IGNITE-15198
>>
>> With best regards,
>> Nikita
>>
>> ср, 17 мар. 2021 г. в 15:50, Mauricio Stekl <ma...@stekl.org>:
>>
>> > Hi,
>> > I agree with Nikita, it would be a very simple way of getting feedback
>> > to
>> > improve the documentation.
>> > This tool in particular is quite easy to integrate into the online docs
>> > template.
>> >
>> > Best,
>> > Mauricio
>> >
>> >
>> >
>> >
>> >
>> > On Tue, Mar 16, 2021 at 4:46 PM Denis Magda <dm...@apache.org> wrote:
>> >
>> > > Nikita, thanks for starting the conversation. I'll just cast my vote
>> for
>> > > the bugyard.io for its ability to select and comment on a specific
>> > > problematic point on a documentation page (a paragraph, sentence,
>> > picture,
>> > > code snippet, etc.). It makes it trivial to share feedback and then
>> it's
>> > > easy to process it on the other side. Those who'd like to experience
>> it,
>> > > click the "Documentation Feedback" button on the GridGain docs:
>> > > https://www.gridgain.com/docs/latest/getting-started/what-is-gridgain
>> > >
>> > > -
>> > > Denis
>> > >
>> > >
>> > > On Tue, Mar 16, 2021 at 3:14 PM Никита Сафонов <
>> > vlasovpavel2011@gmail.com>
>> > > wrote:
>> > >
>> > > > Hello Igniters,
>> > > >
>> > > > I would like to propose an enhancement that can significantly
>> > > > improve
>> > the
>> > > > quality of our documentation.
>> > > >
>> > > > I suggest adding a feedback button (let’s call it a «Documentation
>> > > > feedback» button) to the web site documentation pages so everyone
>> could
>> > > > leave a comment to what is already published.
>> > > >
>> > > > The feedback may refer to the Ignite documentation in general or to
>> > > > a
>> > > > particular section, paragraph, or even term or value.
>> > > >
>> > > > I do believe that we would harvest dozens and hundreds of ideas,
>> > > > suggestions, and observations.
>> > > >
>> > > > I would also suggest using bugyard.io as a solid service for
>> gathering
>> > > > feedback (I’m quite familiar with it, it is easy to implement, use,
>> and
>> > > > maintain).
>> > > >
>> > > > So folks, what do you think of this?
>> > > >
>> > > > With best regards,
>> > > > Nikita
>> > > >
>> > >
>> >
>>
>
--
Best regards,
Ivan Pavlukhin