You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@couchdb.apache.org by Arun Agarwal <ar...@yahoo.com.INVALID> on 2015/03/15 21:14:24 UTC
A cwiki review required and notes
Hi Team.
Added the cwiki pages at:https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDBhttps://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
Notes:
-- Versions for developer preview 2.0 is TBD and we have to fill the right values. not sure if we require nodejs/rebar added to the table.-- I have trimmed/re-worded the documentation guide to some extent, please take a look and verify the hyperlinks if they point to correct locations. we should ideally have a markdown readme in couchdb-documentation repo and twiki should point to the repo page for further documentation. This way the documentation will live with the code and twiki will point to the right documentation.-- We probably should avoid versioning in url scheme example @ http://couchdb.readthedocs.org/en/1.6.1/search.html
this way the urls are no longer bookmarkable and violates the resource semantics as well. at some point we should change it in code.
regards.Arun.
Re: A cwiki review required and notes
Posted by Robert Kowalski <ro...@kowalski.gd>.
Ah, you just changed them. I am +1 for those changes as they focus on
doing and remove details that might be hard for newcomers, like
release-branching. We should take care of that and not someone who
spotted a typo in the docs.
On Tue, Mar 17, 2015 at 10:50 PM, Robert Kowalski <ro...@kowalski.gd> wrote:
> Hi Arun,
>
> great work! Thank you!
>
> Can you provide the url to the pages the new wiki replaces?
>
> My first feedback to
> https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide:
>
> I think we can remove DocBook section - I am participating in the
> project since 1 year and never heard of it or saw it. Jan, Alex or
> Andy can you verify that?
>
> Best,
> Robert
>
> On Sun, Mar 15, 2015 at 9:20 PM, Arun Agarwal
> <ar...@yahoo.com.invalid> wrote:
>> Looks like Yahoo mail is not kind to urls:
>> 1.https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDB
>> 2.
>> https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
>>
>>
>> On Monday, March 16, 2015 1:44 AM, Arun Agarwal <ar...@yahoo.com.INVALID> wrote:
>>
>>
>> Hi Team.
>> Added the cwiki pages at:https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDBhttps://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
>>
>> Notes:
>> -- Versions for developer preview 2.0 is TBD and we have to fill the right values. not sure if we require nodejs/rebar added to the table.-- I have trimmed/re-worded the documentation guide to some extent, please take a look and verify the hyperlinks if they point to correct locations. we should ideally have a markdown readme in couchdb-documentation repo and twiki should point to the repo page for further documentation. This way the documentation will live with the code and twiki will point to the right documentation.-- We probably should avoid versioning in url scheme example @ http://couchdb.readthedocs.org/en/1.6.1/search.html
>> this way the urls are no longer bookmarkable and violates the resource semantics as well. at some point we should change it in code.
>> regards.Arun.
>>
>>
Re: A cwiki review required and notes
Posted by Robert Kowalski <ro...@kowalski.gd>.
Hi Arun,
great work! Thank you!
Can you provide the url to the pages the new wiki replaces?
My first feedback to
https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide:
I think we can remove DocBook section - I am participating in the
project since 1 year and never heard of it or saw it. Jan, Alex or
Andy can you verify that?
Best,
Robert
On Sun, Mar 15, 2015 at 9:20 PM, Arun Agarwal
<ar...@yahoo.com.invalid> wrote:
> Looks like Yahoo mail is not kind to urls:
> 1.https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDB
> 2.
> https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
>
>
> On Monday, March 16, 2015 1:44 AM, Arun Agarwal <ar...@yahoo.com.INVALID> wrote:
>
>
> Hi Team.
> Added the cwiki pages at:https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDBhttps://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
>
> Notes:
> -- Versions for developer preview 2.0 is TBD and we have to fill the right values. not sure if we require nodejs/rebar added to the table.-- I have trimmed/re-worded the documentation guide to some extent, please take a look and verify the hyperlinks if they point to correct locations. we should ideally have a markdown readme in couchdb-documentation repo and twiki should point to the repo page for further documentation. This way the documentation will live with the code and twiki will point to the right documentation.-- We probably should avoid versioning in url scheme example @ http://couchdb.readthedocs.org/en/1.6.1/search.html
> this way the urls are no longer bookmarkable and violates the resource semantics as well. at some point we should change it in code.
> regards.Arun.
>
>
Re: A cwiki review required and notes
Posted by Robert Kowalski <ro...@kowalski.gd>.
Thank you, your help is really appreciated!
On Wed, Mar 18, 2015 at 7:15 AM, Arun Agarwal
<ar...@yahoo.com.invalid> wrote:
> Hey Robert and Alex.
>
> Thanks so much for inputs. As I mentioned in notes(and that echos your suggestions), we should keep doc part of repos and keep only pointers here in twiki.
>
> since I wasn't sure, what to keep and what to remove, I just took the old information to new location and verified the URLs along with some rewording of the sentences (I really liked creativity in the last paragraph though :-) ).
>
> I will continue to slay some of the beasts that come along (of course with the verification help of you giants :P).
> Thanks. more notes to follow.
> regards.arun.
>
>
> On Wednesday, March 18, 2015 4:22 AM, Alexander Shorin <kx...@gmail.com> wrote:
>
>
> On Wed, Mar 18, 2015 at 1:39 AM, Robert Kowalski <ro...@kowalski.gd> wrote:
>> Alex, would you propose to delete this site and their subsites? Can
>> you take care of deleting it?
>
> Yes, I do, if nobody else mind.
>
>> Can we remove the DocBook section in
>> https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
>> ?
>
> TL;DR after few more iterations it's a good stuff for Contribution
> Guide[1] in docs.
>
> Quick notes:
> 1. Links to the documetation repository are in mess between old
> couchdb and new couchdb-documentation
> 2. Steps in Quick Starting Guide are not match to real. There is no
> `share/doc` now
> 3. To build the docs you don't have to run such monster commands. Just
> make html or make pdf or see Makefile[2]
> 4. Links in Generation via ReadTheDocs section are seems references to
> Dave's setup (:
>
>
> [1]: https://github.com/apache/couchdb-documentation/blob/master/src/contributing.rst
> [2]: https://github.com/apache/couchdb-documentation/blob/master/Makefile
>
>
>
> --
> ,,,^..^,,,
>
>
>
Re: A cwiki review required and notes
Posted by Arun Agarwal <ar...@yahoo.com.INVALID>.
Hey Robert and Alex.
Thanks so much for inputs. As I mentioned in notes(and that echos your suggestions), we should keep doc part of repos and keep only pointers here in twiki.
since I wasn't sure, what to keep and what to remove, I just took the old information to new location and verified the URLs along with some rewording of the sentences (I really liked creativity in the last paragraph though :-) ).
I will continue to slay some of the beasts that come along (of course with the verification help of you giants :P).
Thanks. more notes to follow.
regards.arun.
On Wednesday, March 18, 2015 4:22 AM, Alexander Shorin <kx...@gmail.com> wrote:
On Wed, Mar 18, 2015 at 1:39 AM, Robert Kowalski <ro...@kowalski.gd> wrote:
> Alex, would you propose to delete this site and their subsites? Can
> you take care of deleting it?
Yes, I do, if nobody else mind.
> Can we remove the DocBook section in
> https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
> ?
TL;DR after few more iterations it's a good stuff for Contribution
Guide[1] in docs.
Quick notes:
1. Links to the documetation repository are in mess between old
couchdb and new couchdb-documentation
2. Steps in Quick Starting Guide are not match to real. There is no
`share/doc` now
3. To build the docs you don't have to run such monster commands. Just
make html or make pdf or see Makefile[2]
4. Links in Generation via ReadTheDocs section are seems references to
Dave's setup (:
[1]: https://github.com/apache/couchdb-documentation/blob/master/src/contributing.rst
[2]: https://github.com/apache/couchdb-documentation/blob/master/Makefile
--
,,,^..^,,,
Re: A cwiki review required and notes
Posted by Alexander Shorin <kx...@gmail.com>.
On Wed, Mar 18, 2015 at 1:39 AM, Robert Kowalski <ro...@kowalski.gd> wrote:
> Alex, would you propose to delete this site and their subsites? Can
> you take care of deleting it?
Yes, I do, if nobody else mind.
> Can we remove the DocBook section in
> https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
> ?
TL;DR after few more iterations it's a good stuff for Contribution
Guide[1] in docs.
Quick notes:
1. Links to the documetation repository are in mess between old
couchdb and new couchdb-documentation
2. Steps in Quick Starting Guide are not match to real. There is no
`share/doc` now
3. To build the docs you don't have to run such monster commands. Just
make html or make pdf or see Makefile[2]
4. Links in Generation via ReadTheDocs section are seems references to
Dave's setup (:
[1]: https://github.com/apache/couchdb-documentation/blob/master/src/contributing.rst
[2]: https://github.com/apache/couchdb-documentation/blob/master/Makefile
--
,,,^..^,,,
Re: A cwiki review required and notes
Posted by Robert Kowalski <ro...@kowalski.gd>.
Alex, would you propose to delete this site and their subsites? Can
you take care of deleting it?
Can we remove the DocBook section in
https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
?
On Tue, Mar 17, 2015 at 11:21 PM, <ju...@villageonline.info> wrote:
> unsubscribe
>
>
RE: A cwiki review required and notes
Posted by ju...@villageonline.info.
unsubscribe
Re: A cwiki review required and notes
Posted by Alexander Shorin <kx...@gmail.com>.
Hi Arun
On Sun, Mar 15, 2015 at 11:20 PM, Arun Agarwal
<ar...@yahoo.com.invalid> wrote:
> https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDB
This information is incomplete and may cause confusion. All the actual
installation requirements are defined in couchdb root repository in
INSTALL[1] file. There is no need to duplicate this information a lot
(with exception for the docs may be) because multiple source of truth
is harder to maintain and keep consistent instead of the single one.
For instance, R14 support wasn't removed for developers preview.
[1]: https://github.com/apache/couchdb/blob/1.6.x/INSTALL.Unix
--
,,,^..^,,,
Re: A cwiki review required and notes
Posted by Arun Agarwal <ar...@yahoo.com.INVALID>.
Looks like Yahoo mail is not kind to urls:
1.https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDB
2.
https://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
On Monday, March 16, 2015 1:44 AM, Arun Agarwal <ar...@yahoo.com.INVALID> wrote:
Hi Team.
Added the cwiki pages at:https://cwiki.apache.org/confluence/display/COUCHDB/Installing+CouchDBhttps://cwiki.apache.org/confluence/display/COUCHDB/Documentation+Guide
Notes:
-- Versions for developer preview 2.0 is TBD and we have to fill the right values. not sure if we require nodejs/rebar added to the table.-- I have trimmed/re-worded the documentation guide to some extent, please take a look and verify the hyperlinks if they point to correct locations. we should ideally have a markdown readme in couchdb-documentation repo and twiki should point to the repo page for further documentation. This way the documentation will live with the code and twiki will point to the right documentation.-- We probably should avoid versioning in url scheme example @ http://couchdb.readthedocs.org/en/1.6.1/search.html
this way the urls are no longer bookmarkable and violates the resource semantics as well. at some point we should change it in code.
regards.Arun.