You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@knox.apache.org by Kevin Minder <ke...@hortonworks.com> on 2013/09/25 20:04:08 UTC

Stop the presses! Switching back to site/markdown for docs

Hi Everyone,

I just couldn't take doing docs in wiki anymore.  Some of you may also 
know that I rather like Markdown.  So I created some tooling around 
creating a book from multiple markdown files.  You can take a look at 
the current "book" here.
http://knox.incubator.apache.org/books/knox-incubating-0-3-0/knox-incubating-0-3-0.html
The content for this was extracted from the wiki late last night. I'll 
be copying/combining more now from the other wikis.

*However since I'm not sure who has commit access to this repo please 
continue working with the wiki for any changes to existing content in 
the near term. *

I will integrate any changes until I'm comletely caught up.  At which 
point I'll notify everyone and you can switch to working in the site 
possibly with me taking patches from people until we get privs worked 
out.  If you are starting new content please use the site/markdown and 
send me a patch if you can't commit.

Docs for working with the site are updated and available here.
https://cwiki.apache.org/confluence/display/KNOX/Site+Maintenance

The source for this is in the site subversion repo.
https://svn.apache.org/repos/asf/incubator/knox

The source for the 0.3.0 book itself can be found in the 
trunk/books/0.3.0 directory.  The trunk/books/common contains markdown 
that can be shared between books.  The trunk/books/static contains 
static resources (e.g. png, css) that can be shared between books.

Any questions?
Kevin.

-- 
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: Stop the presses! Switching back to site/markdown for docs

Posted by Kevin Minder <ke...@hortonworks.com>.
Hi Everyone,

The markdown version of the doc is starting to take shape.
http://knox.incubator.apache.org/books/knox-incubating-0-3-0/knox-incubating-0-3-0.html

It still needs a bunch of cleanup and validation which I will continue 
to do.  However, I believe the content of this now matches what is in 
the wiki.  So I would like everyone to swtich to using the SVN/Markdown 
version moving forward.  There are instructions for working with this here.
https://cwiki.apache.org/confluence/display/KNOX/Site+Maintenance

In the near term this will create a bit of a burdon on at least me since 
those without write access to the site svn repo will have to submit 
patches for changes.  I'm going to start a [DISCUSS] thread about the 
potential difference between doc committers and code committers.

Kevin.

On 9/25/13 2:04 PM, Kevin Minder wrote:
> Hi Everyone,
>
> I just couldn't take doing docs in wiki anymore.  Some of you may also 
> know that I rather like Markdown.  So I created some tooling around 
> creating a book from multiple markdown files.  You can take a look at 
> the current "book" here.
> http://knox.incubator.apache.org/books/knox-incubating-0-3-0/knox-incubating-0-3-0.html
> The content for this was extracted from the wiki late last night. I'll 
> be copying/combining more now from the other wikis.
>
> *However since I'm not sure who has commit access to this repo please 
> continue working with the wiki for any changes to existing content in 
> the near term. *
>
> I will integrate any changes until I'm comletely caught up.  At which 
> point I'll notify everyone and you can switch to working in the site 
> possibly with me taking patches from people until we get privs worked 
> out.  If you are starting new content please use the site/markdown and 
> send me a patch if you can't commit.
>
> Docs for working with the site are updated and available here.
> https://cwiki.apache.org/confluence/display/KNOX/Site+Maintenance
>
> The source for this is in the site subversion repo.
> https://svn.apache.org/repos/asf/incubator/knox
>
> The source for the 0.3.0 book itself can be found in the 
> trunk/books/0.3.0 directory.  The trunk/books/common contains markdown 
> that can be shared between books.  The trunk/books/static contains 
> static resources (e.g. png, css) that can be shared between books.
>
> Any questions?
> Kevin.


-- 
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.