ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Prachi Garg <pg...@gridgain.com>
Subject Re: Maintaining documentation consistency on readme.io
Date Thu, 25 Aug 2016 17:24:06 GMT
Changes to the existing pages will still have to be copied manually; but
since we are not maintaining two versions (current and future) at the same
time, it may be a lesser overhead. Once a new version is released, we
hardly go back to the previous versions to fix anything.

-P

On Wed, Aug 24, 2016 at 9:42 PM, Dmitriy Setrakyan <dsetrakyan@apache.org>
wrote:

> Prarchi, great idea. We should follow it.
>
> However, this addresses only new content. What about changes to the
> existing pages?
>
> D.
>
> On Wed, Aug 24, 2016 at 5:15 PM, Denis Magda <dmagda@gridgain.com> wrote:
>
> > Prachi,
> >
> > This is an excellent idea!
> >
> > Would you mind adding a new page to this [1] section?
> >
> > After the page is ready we also need to leave a reference to it under
> this
> > [2] section.
> >
> > [1] https://cwiki.apache.org/confluence/display/IGNITE/
> Development+Process
> > <https://cwiki.apache.org/confluence/display/IGNITE/Development+Process>
> > [2] https://cwiki.apache.org/confluence/display/IGNITE/How+
> > to+Contribute#HowtoContribute-Documentation&examples <
> > https://cwiki.apache.org/confluence/display/IGNITE/How+
> > to+Contribute#HowtoContribute-Documentation&examples>
> >
> > —
> > Denis
> >
> > > On Aug 24, 2016, at 10:58 AM, Prachi Garg <pgarg@gridgain.com> wrote:
> > >
> > > Igniters,
> > >
> > > Since readme.io does not automatically copy the changes from the
> current
> > > version to the subsequent version, I have the following suggestion:
> > >
> > > Create the document for future releases within the document for the
> > current
> > > version, and keep the pages hidden. After the new release, create the
> new
> > > version for the document and unhide the pages.
> > >
> > > This way we don't have to manually copy the document between the two
> > > versions.
> > >
> > > Thoughts?
> > >
> > > -Prachi
> >
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message