You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@slider.apache.org by Sumit Mohanty <sm...@hortonworks.com> on 2014/07/01 00:21:15 UTC

Re: website reorganization

What are out options for the next release if CMS is not setup by the time
we plan to release 0.40?

-Sumit


On Tue, Jun 24, 2014 at 1:17 PM, Billie Rinaldi <bi...@gmail.com>
wrote:

> I have made the documentation on our website ready to be used with CMS, and
> opened a ticket to enable CMS.  It may take some time for the new site to
> be set up, but starting now documentation should be edited directly in our
> SVN site at
> https://svn.apache.org/repos/asf/incubator/slider/site/trunk/content/.
>
> In an attempt to organize things a bit, I divided the existing
> documentation into three categories: Design, Developing, and Using.  There
> will be a pull-down menu for each category on the site.  If you can't find
> something, the following may help:
> * the architecture directory is renamed design; registry and specification
> (of slider behavior) are subdirectories of design
> * most of the files formerly on the top level are in a new directory named
> docs (the Using category), and configuration and slider_specs are
> subdirectories of docs
> * the developing and release notes directories remain as is
> * there's now a downloads directory (containing only our downloads page)
>
> Feel free to make additional organizational improvements / rename things or
> whatever.  Once CMS is set up, I'll send out instructions on how to edit
> and publish the site.
>

-- 
CONFIDENTIALITY NOTICE
NOTICE: This message is intended for the use of the individual or entity to 
which it is addressed and may contain information that is confidential, 
privileged and exempt from disclosure under applicable law. If the reader 
of this message is not the intended recipient, you are hereby notified that 
any printing, copying, dissemination, distribution, disclosure or 
forwarding of this communication is strictly prohibited. If you have 
received this communication in error, please contact the sender immediately 
and delete it from your system. Thank You.

Re: website reorganization

Posted by Billie Rinaldi <bi...@gmail.com>.
For Accumulo, we keep some global docs and some release-specific docs that
are placed in directories named for those releases, so you can always see
docs for older releases on the current website.  As far as keeping track of
things in SVN, the CMS setup has top-level trunk and branches directories,
with the current site content living under trunk, so we could easily tag
different versions of the site if we wanted.  As far as I am aware, other
branches would not be built into html, however.


On Mon, Jun 30, 2014 at 4:24 PM, Sumit Mohanty <su...@gmail.com>
wrote:

> Actually, we should do it just before the release as some of the doc
> changes will probably not make sense for the current official release 0.30.
>
> This brings in an interesting problem. If in future someone wants to use
> the older release then they have to look into the doc for that release.
> This means that svn doc repository also needs to be tagged with the release
> versions. Is there a standard best practice to follow?
>
> -Sumit
>
>
> On Mon, Jun 30, 2014 at 4:11 PM, Billie Rinaldi <bi...@gmail.com>
> wrote:
>
> > We can manually generate the site from the svn content.  (
> > http://www.apache.org/dev/cmsref.html#local-build)  Maybe I should do
> that
> > anyway ...
> >
> >
> > On Mon, Jun 30, 2014 at 3:21 PM, Sumit Mohanty <smohanty@hortonworks.com
> >
> > wrote:
> >
> > > What are out options for the next release if CMS is not setup by the
> time
> > > we plan to release 0.40?
> > >
> > > -Sumit
> > >
> > >
> > > On Tue, Jun 24, 2014 at 1:17 PM, Billie Rinaldi <
> > billie.rinaldi@gmail.com>
> > > wrote:
> > >
> > > > I have made the documentation on our website ready to be used with
> CMS,
> > > and
> > > > opened a ticket to enable CMS.  It may take some time for the new
> site
> > to
> > > > be set up, but starting now documentation should be edited directly
> in
> > > our
> > > > SVN site at
> > > >
> https://svn.apache.org/repos/asf/incubator/slider/site/trunk/content/.
> > > >
> > > > In an attempt to organize things a bit, I divided the existing
> > > > documentation into three categories: Design, Developing, and Using.
> > >  There
> > > > will be a pull-down menu for each category on the site.  If you can't
> > > find
> > > > something, the following may help:
> > > > * the architecture directory is renamed design; registry and
> > > specification
> > > > (of slider behavior) are subdirectories of design
> > > > * most of the files formerly on the top level are in a new directory
> > > named
> > > > docs (the Using category), and configuration and slider_specs are
> > > > subdirectories of docs
> > > > * the developing and release notes directories remain as is
> > > > * there's now a downloads directory (containing only our downloads
> > page)
> > > >
> > > > Feel free to make additional organizational improvements / rename
> > things
> > > or
> > > > whatever.  Once CMS is set up, I'll send out instructions on how to
> > edit
> > > > and publish the site.
> > > >
> > >
> > > --
> > > CONFIDENTIALITY NOTICE
> > > NOTICE: This message is intended for the use of the individual or
> entity
> > to
> > > which it is addressed and may contain information that is confidential,
> > > privileged and exempt from disclosure under applicable law. If the
> reader
> > > of this message is not the intended recipient, you are hereby notified
> > that
> > > any printing, copying, dissemination, distribution, disclosure or
> > > forwarding of this communication is strictly prohibited. If you have
> > > received this communication in error, please contact the sender
> > immediately
> > > and delete it from your system. Thank You.
> > >
> >
>
>
>
> --
> thanks
> Sumit
>

Re: website reorganization

Posted by Sumit Mohanty <su...@gmail.com>.
Actually, we should do it just before the release as some of the doc
changes will probably not make sense for the current official release 0.30.

This brings in an interesting problem. If in future someone wants to use
the older release then they have to look into the doc for that release.
This means that svn doc repository also needs to be tagged with the release
versions. Is there a standard best practice to follow?

-Sumit


On Mon, Jun 30, 2014 at 4:11 PM, Billie Rinaldi <bi...@gmail.com>
wrote:

> We can manually generate the site from the svn content.  (
> http://www.apache.org/dev/cmsref.html#local-build)  Maybe I should do that
> anyway ...
>
>
> On Mon, Jun 30, 2014 at 3:21 PM, Sumit Mohanty <sm...@hortonworks.com>
> wrote:
>
> > What are out options for the next release if CMS is not setup by the time
> > we plan to release 0.40?
> >
> > -Sumit
> >
> >
> > On Tue, Jun 24, 2014 at 1:17 PM, Billie Rinaldi <
> billie.rinaldi@gmail.com>
> > wrote:
> >
> > > I have made the documentation on our website ready to be used with CMS,
> > and
> > > opened a ticket to enable CMS.  It may take some time for the new site
> to
> > > be set up, but starting now documentation should be edited directly in
> > our
> > > SVN site at
> > > https://svn.apache.org/repos/asf/incubator/slider/site/trunk/content/.
> > >
> > > In an attempt to organize things a bit, I divided the existing
> > > documentation into three categories: Design, Developing, and Using.
> >  There
> > > will be a pull-down menu for each category on the site.  If you can't
> > find
> > > something, the following may help:
> > > * the architecture directory is renamed design; registry and
> > specification
> > > (of slider behavior) are subdirectories of design
> > > * most of the files formerly on the top level are in a new directory
> > named
> > > docs (the Using category), and configuration and slider_specs are
> > > subdirectories of docs
> > > * the developing and release notes directories remain as is
> > > * there's now a downloads directory (containing only our downloads
> page)
> > >
> > > Feel free to make additional organizational improvements / rename
> things
> > or
> > > whatever.  Once CMS is set up, I'll send out instructions on how to
> edit
> > > and publish the site.
> > >
> >
> > --
> > CONFIDENTIALITY NOTICE
> > NOTICE: This message is intended for the use of the individual or entity
> to
> > which it is addressed and may contain information that is confidential,
> > privileged and exempt from disclosure under applicable law. If the reader
> > of this message is not the intended recipient, you are hereby notified
> that
> > any printing, copying, dissemination, distribution, disclosure or
> > forwarding of this communication is strictly prohibited. If you have
> > received this communication in error, please contact the sender
> immediately
> > and delete it from your system. Thank You.
> >
>



-- 
thanks
Sumit

Re: website reorganization

Posted by Billie Rinaldi <bi...@gmail.com>.
We can manually generate the site from the svn content.  (
http://www.apache.org/dev/cmsref.html#local-build)  Maybe I should do that
anyway ...


On Mon, Jun 30, 2014 at 3:21 PM, Sumit Mohanty <sm...@hortonworks.com>
wrote:

> What are out options for the next release if CMS is not setup by the time
> we plan to release 0.40?
>
> -Sumit
>
>
> On Tue, Jun 24, 2014 at 1:17 PM, Billie Rinaldi <bi...@gmail.com>
> wrote:
>
> > I have made the documentation on our website ready to be used with CMS,
> and
> > opened a ticket to enable CMS.  It may take some time for the new site to
> > be set up, but starting now documentation should be edited directly in
> our
> > SVN site at
> > https://svn.apache.org/repos/asf/incubator/slider/site/trunk/content/.
> >
> > In an attempt to organize things a bit, I divided the existing
> > documentation into three categories: Design, Developing, and Using.
>  There
> > will be a pull-down menu for each category on the site.  If you can't
> find
> > something, the following may help:
> > * the architecture directory is renamed design; registry and
> specification
> > (of slider behavior) are subdirectories of design
> > * most of the files formerly on the top level are in a new directory
> named
> > docs (the Using category), and configuration and slider_specs are
> > subdirectories of docs
> > * the developing and release notes directories remain as is
> > * there's now a downloads directory (containing only our downloads page)
> >
> > Feel free to make additional organizational improvements / rename things
> or
> > whatever.  Once CMS is set up, I'll send out instructions on how to edit
> > and publish the site.
> >
>
> --
> CONFIDENTIALITY NOTICE
> NOTICE: This message is intended for the use of the individual or entity to
> which it is addressed and may contain information that is confidential,
> privileged and exempt from disclosure under applicable law. If the reader
> of this message is not the intended recipient, you are hereby notified that
> any printing, copying, dissemination, distribution, disclosure or
> forwarding of this communication is strictly prohibited. If you have
> received this communication in error, please contact the sender immediately
> and delete it from your system. Thank You.
>