[DISCUSSION] Documentation feedback button

[Никита Сафонов]

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

[dmagda]

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 Никита Сафонов <[hidden email]>
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
>

[Mauricio Stekl-2]

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 <[hidden email]> 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 Никита Сафонов <[hidden email]>
> 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
> >
>