Home | About | Sematext search-lucene.com search-hadoop.com
 Search Hadoop and all its subprojects:

Switch to Plain View
Kafka >> mail # user >> Re: site updates

Joel Koshy 2013-06-29, 00:56
Copy link to this message
Re: site updates
Ack, nice catch--that migration tool thing was due to bad html, I
forgot to close the link.

For the configuration I actually think that is not right. We need to
thoroughly document our configuration. Having the code/scaladoc be the
documentation is fine for kafka developers but not where we want to

In the future I would love us to move to a method of defining configs
that was something like:
  configs.define(name = "port",
                        documentation="The port used by the kafka
broker to handle requests.")
If we did it this way we could actually have a dumpConfigs method that
would print out the up-to-date table of configs so we could more
easily keep the docs in sync.

For the time being, though, we should just keep the docs updated.


On Fri, Jun 28, 2013 at 5:55 PM, Joel Koshy <[EMAIL PROTECTED]> wrote:
> Looks good overall - thanks a lot for the improvements.
> Couple of comments: clicking on the 0.7 link goes to the migration
> page (which should probably be on the 0.8 link)
> Also, for the configuration.html file, I used to find the old scala
> docs pointing to the actual *Config classes more current and
> informative. The site can drift over time.
> Joel
> On Fri, Jun 28, 2013 at 2:49 PM, Sriram Subramanian
> <[EMAIL PROTECTED]> wrote:
>> On 6/28/13 2:48 PM, "Sriram Subramanian" <[EMAIL PROTECTED]>
>> wrote:
>>>1. I have moved the FAQ to a wiki. I have separated the sections into
>>>producer, consumers and broker related questions. I would still need to
>>>add replication FAQ. The main FAQ will now link to this. Let me know if
>>>you guys have better ways of representing the FAQ.
>>>2. I yanked the implementation part of the design doc and added it as a
>>>separate section for 0.7. We need to add similar section for 0.8.
>>>3. I also made the migration link directly point to the wiki. It might
>>>also make sense to convert the wiki to an html page.
>>>On 6/27/13 7:17 PM, "Sriram Subramanian" <[EMAIL PROTECTED]>
>>>>Looks much better.
>>>>1. We need to update FAQ for 0.8
>>>>2. We should probably have a separate section for implementation.
>>>>3. The migration tool explanation seems to be hard to get to.
>>>>On 6/27/13 5:40 PM, "Jay Kreps" <[EMAIL PROTECTED]> wrote:
>>>>>Hey Folks,
>>>>>I did a pass on the website. Changes:
>>>>>1. Rewrote the 0.8 quickstart and included a section on running in
>>>>>distributed mode.
>>>>>2. Fixed up the styles a bit.
>>>>>3. Fixed the bizarre menu thing with 0.7 and 0.8 specific docs.
>>>>>4. Re-wrote the copy on the front page.
>>>>>I would love to get any feedback on how we could improve the site,
>>>>>documentation, etc.
>>>>>I would like to do at least the following:
>>>>>1. Generate scaladoc just for the client classes.
>>>>>2. See if there isn't some way to generate javadoc for the java api
>>>>>3. Rewrite the design document for 0.8
>>>>>4. Update the operations guide to cover 0.8

Jun Rao 2013-06-30, 22:32
Markus Roder 2013-07-03, 12:43
Jay Kreps 2013-07-03, 20:37