It seems that everyone is in favor of keeping the docs updated in each jira.
As for the next step, anyone wants to help figure out if it's possible to
move the website to git?
Thanks,
Jun
On Tue, Mar 31, 2015 at 10:03 AM, Gwen Shapira
wrote:
> +1
>
> On Tue, Mar 31, 2015 at 9:23 AM, Jay Kreps
+1
On Tue, Mar 31, 2015 at 9:23 AM, Jay Kreps wrote:
> Yeah the protocol should probably move off the wiki and into the
> release-versioned docs.
>
> -Jay
>
> On Mon, Mar 30, 2015 at 5:17 PM, Joel Koshy wrote:
>
>> Also for the wikis - those should probably correspond to the latest
>> released v
Yeah the protocol should probably move off the wiki and into the
release-versioned docs.
-Jay
On Mon, Mar 30, 2015 at 5:17 PM, Joel Koshy wrote:
> Also for the wikis - those should probably correspond to the latest
> released version right? So for e.g., if we add or modify the protocol
> on tru
For the wire protocol in the wiki, we need to tag each new request version
with the first release when it's supported. So, currently, any new request
version introduced in trunk will be tagged with 0.8.3.
Thanks,
Jun
On Mon, Mar 30, 2015 at 5:17 PM, Joel Koshy wrote:
> Also for the wikis - tho
Also for the wikis - those should probably correspond to the latest
released version right? So for e.g., if we add or modify the protocol
on trunk we can add it to the wiki but mark it with some highlight or
similar just to make it clear that it is a change on trunk only.
Thanks,
Joel
On Thu, Ma
Yeah that sounds good to me. That would involve someone converting us over
to the templating system we chose (something like Jenkyll would be easy
since it allows inline HTML, so we'd just have to replace the apache
includes). It's also quite possible that Apache has solved the whole
SVN/website de
On Thu, Mar 26, 2015 at 9:46 PM, Jay Kreps wrote:
> The reason the docs are in svn is that when we were setting up the site
> apache required that to publish doc changes. Two possible fixes:
> 1. Follow up with infra to see if they have git integration working yet
> 2. Move to a model where doc "s
The reason the docs are in svn is that when we were setting up the site
apache required that to publish doc changes. Two possible fixes:
1. Follow up with infra to see if they have git integration working yet
2. Move to a model where doc "source" is kept in the main git and we use
jenkyl or somethi
On 3/26/15, 7:00 PM, "Neha Narkhede" wrote:
>>
>> Much much easier to do this if the docs are in git and can be reviewed
>>and
>> committed / reverted with the code (transactions makes synchronization
>> easier...).
+1 on this, too!
>
>
>Huge +1.
>
>On Thu, Mar 26, 2015 at 6:54 PM, Joel Koshy
>
> Much much easier to do this if the docs are in git and can be reviewed and
> committed / reverted with the code (transactions makes synchronization
> easier...).
Huge +1.
On Thu, Mar 26, 2015 at 6:54 PM, Joel Koshy wrote:
> +1
>
> It is indeed too easy to forget and realize only much later
+1
It is indeed too easy to forget and realize only much later that a
jira needed a doc update. So getting into the habit of asking "did you
update the docs" as part of review will definitely help.
On Thu, Mar 26, 2015 at 06:36:43PM -0700, Gwen Shapira wrote:
> I strongly support the goal of keep
+1. I will update the protocol per KAFKA-1634.
On Thu, Mar 26, 2015 at 6:27 PM, Jun Rao wrote:
> Hi, Everyone,
>
> Quite a few jiras these days require documentation changes (e.g., wire
> protocol, ZK layout, configs, jmx, etc). Historically, we have been
> updating the documentation just before
I strongly support the goal of keeping docs and code in sync.
Much much easier to do this if the docs are in git and can be reviewed and
committed / reverted with the code (transactions makes synchronization
easier...).
This will also allow us to:
1. Include the docs in the bits we release
2. On
Could we move to git from svn so we can have the docs in the patch with the
code too, easier to review and commit and work on for contribs also? To
start we could do something easy like create a new directory /site cp -r
from svn and then when we release cp -r /site/* svn/site and commit for the
re
Hi, Everyone,
Quite a few jiras these days require documentation changes (e.g., wire
protocol, ZK layout, configs, jmx, etc). Historically, we have been
updating the documentation just before we do a release. The issue is that
some of the changes will be missed since they were done a while back.
A
15 matches
Mail list logo
