[ANNOUNCE] GitHub repository couchdb-documentation has been archived

2022-10-17 Thread Ronny Berndt

Hi everyone,

just a quick announcement that the GitHub repository couchdb-documentation has 
been archived. 
The docs were integrated on September 12th, 2022 into the main couchdb
repository.

Tasks performed:

- Migrate GH webhook for building docs into the main repo
- All open issues were migrated into the main repo.
- Closed all (3) open PR's
- Archive apache/couchdb-documentation to prevent modification

Thanks to Jan, Nick and the INFRA team for their support.

Cheers,
Ronny


[GitHub] couchdb-documentation pull request #119: Remove references to all_or_nothing...

2017-04-03 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/119


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #119: Remove references to all_or_nothing for _b...

2017-04-03 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/119
  
+1

Thank you!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #119: Remove references to all_or_nothing...

2017-04-02 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/119

Remove references to all_or_nothing for _bulk_docs

... as this was removed in 2.0.0

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation all-or-nothing

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/119.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #119


commit 6541581e39207b9bcb2c838aed0d785024b713c5
Author: Jonathan Hall 
Date:   2017-04-02T23:11:14Z

Remove references to all_or_nothing for _bulk_docs

... as this was removed in 2.0.0




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #118: Update changes feed documentation

2017-04-02 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/118

Update changes feed documentation



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation changes

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/118.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #118


commit b4da4ba3fe4323bcb92b9565dd7ec28dc247a0a8
Author: Jonathan Hall 
Date:   2017-03-18T20:16:23Z

Update changes feed documentation




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #117: Tiny tidy-up in the Theory Chapter

2017-03-30 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/117
  
+1

Thank you for your contribution!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #117: Tiny tidy-up in the Theory Chapter

2017-03-30 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/117


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #31: added Mango docs

2017-03-29 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/31
  
Yes, we need the ASF License header in every file for sure. We also need to 
reconcile this with the other Mango docs that landed over here: 
https://github.com/apache/couchdb-documentation/pull/55 In other words, make 
sure the content, tone and advice match.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #117: Tiny tidy-up in the Theory Chapter

2017-03-29 Thread lornajane
GitHub user lornajane opened a pull request:

https://github.com/apache/couchdb-documentation/pull/117

Tiny tidy-up in the Theory Chapter

Fixes a minor to/too typo and improves the English for readability.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/lornajane/couchdb-documentation 
minor-theory-typo

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/117.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #117


commit 35d5cfe0f20b0bf1cd895fc03a28498c3d07a268
Author: Lorna Jane Mitchell 
Date:   2017-03-29T14:50:32Z

Really minor changes, to improve the English

Fixes a minor to/too typo




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #31: added Mango docs

2017-03-29 Thread lornajane
Github user lornajane commented on the issue:

https://github.com/apache/couchdb-documentation/pull/31
  
If @KimStebel doesn't have time, I can probably pick this up - is it just a 
case of trying to get the final failing checks to pass?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


CouchDB Documentation guidelines

2017-03-20 Thread Jonathan Hall
In the last month I've been reading through a lot of CouchDB 
documentation, as I'm writing a CouchDB Client API library. As such, 
I've had a lot of opportunity to submit documentation update PRs. But I 
find myself wishing for greater guidance than can be found simply by 
reading the existing documentation, as there's not always a lot of 
consistency in the docs.


I opened a GitHub issue asking for such guidance, and was referred 
here.  What guidance can this list offer, so that I can work toward 
formulating a contributor guideline for CouchDB documentation?


Feel free to respond here, or on GitHub: 
https://github.com/apache/couchdb-documentation/issues/111


Below is my original post:

As I'm finding myself contributing more and more PRs to this 
documentation, I wish I had some guidelines, other than the existing 
docs, for what's acceptable.


 * How detailed should descriptions be?
 * Are config options expected to always show default values? Or is any
   valid value permitted?
 * Is it appropriate to retroactively update|whatsnew|documentation?
 * (Where) should documentation changes be discussed before submitting
   a PR?

And I'm sure many more questions will come up.

Are these things documented somewhere? I'd be happy to turn them into a 
CONTRIBUTING.md document and submitting a PR. :)





[GitHub] couchdb-documentation pull request #48: Fix the build, and fix the location ...

2017-03-19 Thread philip-morning
Github user philip-morning closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/48


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #48: Fix the build, and fix the location of the ...

2017-03-19 Thread philip-morning
Github user philip-morning commented on the issue:

https://github.com/apache/couchdb-documentation/pull/48
  
Yes. :-) Thank you for working on CouchDB.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb pull request #459: Bump couchdb-documentation dependency

2017-03-19 Thread wohali
GitHub user wohali opened a pull request:

https://github.com/apache/couchdb/pull/459

Bump couchdb-documentation dependency



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/apache/couchdb master

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb/pull/459.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #459


commit 112501c6db959489b077fa9ad2350b2ffc25de54
Author: Joan Touzet 
Date:   2017-03-19T23:35:04Z

Document additional package for Ubuntu 16.04 build

commit 80928ab70d4f2e75746fd3b86c05b575d8483fb7
Author: Joan Touzet 
Date:   2017-03-19T23:51:47Z

Merge pull request #457 from apache/3329-kill-pdf-texinfo

Remove PDF, TeX/LaTeX and texinfo from the build chain.

Note if you are still looking for PDF (or epub!) versions of
our documentation, you can get these auto-built at 
https://docs.couchdb.org/ .




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb pull request #459: Bump couchdb-documentation dependency

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb/pull/459


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #111: Requesting a CONTRIBUTING.md document

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/issues/111
  
I recommend you join the dev@couchdb.apache.org mailing list and post this 
question there, where it might get a bit more attention. (GH issues are brand 
new to CouchDB and aren't being watched carefully yet.) And it's probably the 
answer to your last question as well. :)

I'd love to review and help you merge a CONTRIBUTING.md once you've got the 
answers you need.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #92: remove documentation about couch_peruser ap...

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/92
  
While CouchDB has a plan to supplement couch-peruser in the 3.0+ timeframe, 
if we can fix couch-peruser for 2.0 that'd be nice. I don't know, to be honest. 
That said I don't want to ship 2.1.0 with a broken feature. (2.1.0 is probably 
a couple of months away, summer at latest.)

@KlausTrainer if you don't think you'll get to this soon, we should 
probably archive the documentation and the implementation.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #72: Update rewrites.rst

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/72


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #72: Update rewrites.rst

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/72
  
1.7 is still pending; I believe this feature is being backported to it or 
was in 1.6.1, I can't remember. @kxepal can tell me for sure.

Either way I think I will close this PR.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #54: Use the proper location for `require...

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/54


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #48: Fix the build, and fix the location of the ...

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/48
  
Hi @philip-morning I think most of these changes have landed by other PRs. 
Do you agree we can close this PR?

Thank you for your contributions to CouchDB! :)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #45: point all URLs/paths to the docs repo

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/45
  
Addressed by 
https://github.com/apache/couchdb-documentation/commit/5a83d74d119a8fb4ad91fed5d47103df2278ad0e#diff-12fcdd2a80ce34d385e51076837c42f1

Thanks for your contribution to Apache CouchDB!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #45: point all URLs/paths to the docs rep...

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/45


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #43: Removing _rev

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/43
  
@timmillwood any interest in reviving this PR? If not we should close it 
out.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---



[GitHub] couchdb-documentation issue #31: added Mango docs

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/31
  
Hi @KimStebel I know you may have moved on, but any interest in cleaning 
this up and helping us get this PR landed?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #22: document _config changes

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/22


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #22: document _config changes

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/22
  
Resolved as part of PR#109.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #20: Clarify provides() usage in _list fu...

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/20


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #13: no, you can't use emit() in a list f...

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/13


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #13: no, you can't use emit() in a list function...

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/13
  
Fixed in 
https://github.com/apache/couchdb-documentation/commit/91d4405b3f5831a97b9576b27d5ca756c15abe9a
 and thank you for your contribution to CouchDB!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #115: Update _db_updates documentation fo...

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/115


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #115: Update _db_updates documentation for Couch...

2017-03-19 Thread wohali
Github user wohali commented on the issue:

https://github.com/apache/couchdb-documentation/pull/115
  
+1, thank you!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #116: Remove pdf and info builds from def...

2017-03-19 Thread wohali
Github user wohali closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/116


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #116: Remove pdf and info builds from def...

2017-03-18 Thread wohali
GitHub user wohali opened a pull request:

https://github.com/apache/couchdb-documentation/pull/116

Remove pdf and info builds from default target

As discussed on the mailing list, this removes the PDF and info
builds from the default build.

Fixes COUCHDB-3329

Relates to apache/couchdb:3329-kill-pdf-texinfo branch.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/apache/couchdb-documentation 
3329-kill-pdf-texinfo

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/116.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #116


commit 2474c99cd23aab89823df8901afb1a690b63fb1d
Author: Joan Touzet 
Date:   2017-03-19T06:37:18Z

Remove pdf and info builds from default target




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #115: Update _db_updates documentation fo...

2017-03-18 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/115

Update _db_updates documentation for CouchDB 2.0.0



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation dbupdates

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/115.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #115


commit 38998dd851dd1b0db9188cb85259ab95303118c9
Author: Jonathan Hall 
Date:   2017-03-18T19:00:36Z

Update _db_updates documentation for CouchDB 2.0.0




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #113: Bring back the correct implementati...

2017-03-17 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/113


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #114: Flesh out the documentation for POS...

2017-03-16 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/114


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #114: Flesh out the documentation for POST /{db}...

2017-03-16 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/114
  
+1

Thank you!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #110: Remove /_log references from the do...

2017-03-16 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/110


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #110: Remove /_log references from the documenta...

2017-03-16 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/110
  
Looks great. Thank you!

+1



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #110: Remove /_log references from the do...

2017-03-16 Thread nickva
Github user nickva commented on a diff in the pull request:


https://github.com/apache/couchdb-documentation/pull/110#discussion_r10635
  
--- Diff: src/api/server/common.rst ---
@@ -324,79 +324,6 @@
 ]
 }
 
-.. _api/server/log:
-
-=
-``/_log``
-=
-
-.. http:get:: /_log
-:synopsis: Returns the server log file
-
-Gets the CouchDB log, equivalent to accessing the local log file of the
-corresponding CouchDB instance.
-
-:header Content-Type: :mimetype:`text/plain; charset=utf-8`
-:>header Transfer-Encoding: ``chunked``
-:code 200: Request completed successfully
-:code 401: CouchDB Server Administrator privileges required
-
-**Request**:
-
-.. code-block:: http
-
-GET /_log HTTP/1.1
-Accept: application/json
-Host: localhost:5984
-
-**Response**:
-
-.. code-block:: text
-
-[Wed, 27 Oct 2010 10:49:42 GMT] [info] [<0.23338.2>] 192.168.0.2 - 
- 'PUT' /authdb 401
-[Wed, 27 Oct 2010 11:02:19 GMT] [info] [<0.23428.2>] 192.168.0.116 
- - 'GET' /recipes/FishStew 200
-[Wed, 27 Oct 2010 11:02:19 GMT] [info] [<0.23428.2>] 192.168.0.116 
- - 'GET' /_session 200
-[Wed, 27 Oct 2010 11:02:19 GMT] [info] [<0.24199.2>] 192.168.0.116 
- - 'GET' / 200
-[Wed, 27 Oct 2010 13:03:38 GMT] [info] [<0.24207.2>] 192.168.0.116 
- - 'GET' /_log?offset=5 200
-
-If you want to pick out specific parts of the log information you can use 
the
-``bytes`` argument, which specifies the number of bytes to be returned,
-and ``offset``, which specifies where the reading of the log should start,
-counted back from the end. For example, if you use the following request:
-
-.. code-block:: http
-
-GET /_log?bytes=500&offset=2000 HTTP/1.1
-
-Reading of the log will start at 2000 bytes from the end of the log, and 
500
-bytes will be shown.
-
-**How bytes/offset works?**
-
-CouchDB reads specified amount of ``bytes`` from the end of log file, 
jumping
-to ``offset`` bytes towards the beginning of the file first:
-
-.. code-block:: text
-
- Log FileFilePos
- --
-|  |  10
-|  |  20
-|  |  30
-|  |  40
-|  |  50
-|  |  60
-|  |  70 -- Bytes = 20  --
-|  |  80 | Chunk
-|  |  90 -- Offset = 10 --
-|__| 100
-
-.. _api/server/replicate:
--- End diff --

The deletion removed too much. Let's bring api/server/replicate part back 
as it's part of the next section.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #109: Update _config endpoint documentation to r...

2017-03-16 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/109
  
+1 Thank you, @flimzy !


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #109: Update _config endpoint documentati...

2017-03-16 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/109


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #108: Update documentation for logging options

2017-03-16 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/108
  
+1

Thank you again for your contribution! This looks much better.

Will rebase and merge



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #108: Update documentation for logging op...

2017-03-16 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/108


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #108: Update documentation for logging op...

2017-03-16 Thread nickva
Github user nickva commented on a diff in the pull request:


https://github.com/apache/couchdb-documentation/pull/108#discussion_r106332890
  
--- Diff: src/config/logging.rst ---
@@ -68,6 +106,38 @@ Logging options
 
 .. _SASL: http://www.erlang.org/doc/apps/sasl/
 
+.. config:option:: syslog_host
+
+Specifies the syslog host to send logs to. Only used by the
+``syslog`` :option:`writer `.
--- End diff --

This might need to be followed by '::' so the [log] section is rendered in 
fixed-width font and colorized to stand out. Check out 
https://github.com/apache/couchdb-documentation/blob/master/src/config/compaction.rst
 file for example where it has




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #114: Flesh out the documentation for POS...

2017-03-16 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/114

Flesh out the documentation for POST /{db}/_all_docs



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation alldocs

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/114.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #114


commit 49e8d136d1bb2928d36b38dec1a24141085a7433
Author: Jonathan Hall 
Date:   2017-03-16T09:22:28Z

Flesh out the documentation for POST /{db}/_all_docs




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #108: Update documentation for logging options

2017-03-16 Thread flimzy
Github user flimzy commented on the issue:

https://github.com/apache/couchdb-documentation/pull/108
  
Thanks for the suggestions. And doubly thanks for the patience. This is my 
first foray into RST editing, so many of these subtleties don't stand out to me 
just yet.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #109: Update _config endpoint documentation to r...

2017-03-16 Thread flimzy
Github user flimzy commented on the issue:

https://github.com/apache/couchdb-documentation/pull/109
  
> This needs a bit of a fix with length of underline for some titles.

Fixed.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #110: Remove /_log references from the documenta...

2017-03-16 Thread flimzy
Github user flimzy commented on the issue:

https://github.com/apache/couchdb-documentation/pull/110
  
> Looks good except for one part were too much as removed (the 
api/server/replicate label)

Yipes! Thanks for catching. I've updated the PR to correct that.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #113: Bring back the correct implementati...

2017-03-15 Thread nickva
GitHub user nickva opened a pull request:

https://github.com/apache/couchdb-documentation/pull/113

Bring back the correct implementation of max_document_size

COUCHDB-2992

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/cloudant/couchdb-documentation couchdb-2992

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/113.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #113


commit 55cad9af960e4d299bbf387a9e57cd8c7e6273c8
Author: Nick Vatamaniuc 
Date:   2017-03-16T04:07:02Z

Bring back the correct implementation of max_document_size

COUCHDB-2992




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #112: Update documentation for the GET /{db}/ en...

2017-03-15 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/112
  
Thank you!

+1


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #112: Update documentation for the GET /{...

2017-03-15 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/112


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #110: Remove /_log references from the documenta...

2017-03-15 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/110
  
Looks good except for one part were too much as removed (the  
api/server/replicate label)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #109: Update _config endpoint documentation to r...

2017-03-15 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/109
  
@flimzy  Another good fix. Thanks again!

This needs a bit of a fix with length of underline for some titles.
For example:
```
(pr/109) $ make
sphinx-build -b html -a -W -n -A local=1 -D latex_elements.papersize=a4 -d 
build/doctree src/ build/html
Running Sphinx v1.4.5
loading pickled environment... done
building [mo]: all of 0 po files
building [html]: all source files
updating environment: 0 added, 11 changed, 0 removed
reading sources... [100%] whatsnew/2.0

Warning, treated as error:
.../src/docs/src/api/server/configuration.rst:23: WARNING: Title underline 
too short.

``/_node/{node-name}/_config``

```


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #108: Update documentation for logging options

2017-03-15 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/108
  
Thank, you @flimzy 

I fixed a small typo in "option" (made a small commit in GH directly).

The content looks good, I let's tweak the formatting a bit. I think the 
option example section an extra '::' before them so they stand out when they 
are rendered.

For example:

```
   .. config:option:: syslog_port

Specifies the syslog port to connect to when sending logs. Only 
used by
the ``syslog`` :option:`writer `.

[log]
syslog_port = 514
```

Compared to: 

```
The delay, in seconds, between each check for which database and 
view
indexes need to be compacted::

[compaction_daemon]
check_interval = 300
```

Notice the '::' bit


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #103: Update references to `update_seq` t...

2017-03-15 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/103


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #112: Update documentation for the GET /{...

2017-03-15 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/112

Update documentation for the GET /{db}/ endpoint.



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation dbinfo

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/112.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #112


commit cc1967b3461a18f015aee241484af9dfbabbd908
Author: Jonathan Hall 
Date:   2017-03-15T16:55:24Z

Update description of GET /{db}/ response fields

commit 46139812aee1c3c83e3e3da24fa16031179f9b6b
Author: Jonathan Hall 
Date:   2017-03-15T17:03:41Z

Describe the new sizes API in DB info




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #111: Requesting a CONTRIBUTING.md document

2017-03-15 Thread flimzy
GitHub user flimzy opened an issue:

https://github.com/apache/couchdb-documentation/issues/111

Requesting a CONTRIBUTING.md document

As I'm finding myself contributing more and more PRs to this documentation, 
I wish I had some guidelines, other than the existing docs, for what's 
acceptable.

- How detailed should descriptions be?
- Are config options expected to always show default values? Or is any 
valid value permitted?
- Is it appropriate to retroactively update `whatsnew` documentation?
- (Where) should documentation changes be discussed before submitting a PR?

And I'm sure many more questions will come up.

Are these things documented somewhere? I'd be happy to turn them into a 
CONTRIBUTING.md document and submitting a PR. :)






---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #109: Update _config endpoint documentati...

2017-03-13 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/109

Update _config endpoint documentation to reflect new location



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation config

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/109.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #109


commit 5af5be074bc34ddf513260f740d6e2f9eb7aabcf
Author: Jonathan Hall 
Date:   2017-03-13T19:41:14Z

Update _config endpoint documentation to reflect new location




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #108: Document the log.writer option

2017-03-13 Thread flimzy
Github user flimzy commented on a diff in the pull request:


https://github.com/apache/couchdb-documentation/pull/108#discussion_r105749720
  
--- Diff: src/api/server/common.rst ---
@@ -333,6 +333,9 @@
 .. http:get:: /_log
 :synopsis: Returns the server log file
 
+.. warning::
+The ``/_log`` endpoint was removed in CouchDB 2.0.0.
+
--- End diff --

Or would it be better to delete this entire section?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #108: Document the log.writer option

2017-03-13 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/108

Document the log.writer option

I adapted the description from that found in the default.ini.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation logging

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/108.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #108


commit 0d3bcfdd9f4fd2f0d78c6179daa41d8108a9d855
Author: Jonathan Hall 
Date:   2017-03-13T18:53:12Z

Document the log.writer option

I adapted the description from that found in the default.ini.




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #106: Clarify use of 'rev' query paramete...

2017-03-13 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/106


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #106: Clarify use of 'rev' query parameter in do...

2017-03-13 Thread flimzy
Github user flimzy commented on the issue:

https://github.com/apache/couchdb-documentation/pull/106
  
@nickva Updated.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation issue #106: Clarify use of 'rev' query parameter in do...

2017-03-13 Thread nickva
Github user nickva commented on the issue:

https://github.com/apache/couchdb-documentation/pull/106
  
Thank you for your contribution. Would you mind shortening the `query 
string rev` line and possibly others to be less than 80 characters. There is 
linter check which runs and fails on that. 

Locally `make check` should show success. Can also try to commit and then 
Travis CI will also show success of failure.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #107: Documentation updates for DELETE /_...

2017-03-13 Thread nickva
Github user nickva closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/107


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #107: Documentation updates for DELETE /_...

2017-03-12 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/107

Documentation updates for DELETE /_session



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation deletesession

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/107.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #107


commit 6839d5e6c13207c1f0bd020c4eb989b93302d25a
Author: Jonathan Hall 
Date:   2017-03-12T18:07:23Z

DELETE /_session never returns 401

Extensive testing in both CouchDB 2.0.0 and 1.6.1 shows that DELETE
/_session only ever returns 200, even when there is no session, an expired
session, or an invalid session cookie.

commit 6dc0bc10e6b52ac975647fabf2bb0b26ce35
Author: Jonathan Hall 
Date:   2017-03-12T18:09:53Z

Expand documentation for DELETE /_session




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request #106: Clarify use of 'rev' query paramete...

2017-03-12 Thread flimzy
GitHub user flimzy opened a pull request:

https://github.com/apache/couchdb-documentation/pull/106

Clarify use of 'rev' query parameter in document PUT

The previous version mentions 'If-Match' as an "alternative to rev query
parameter", but doesn't mention the rev query parameter. This fixes that
discrepency, and further elaborates on how the rev parameter is used and
when it is necessary.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/flimzy/couchdb-documentation putrev

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/couchdb-documentation/pull/106.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #106


commit c03fcfc0ff9c7a1269edc6422d26691123ae3b05
Author: Jonathan Hall 
Date:   2017-03-09T10:57:34Z

Clarify use of 'rev' query parameter in document PUT

The previous version mentions 'If-Match' as an "alternative to rev query
parameter", but doesn't mention the rev query parameter. This fixes that
discrepency, and further elaborates on how the rev parameter is used and
when it is necessary.




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread asfgit
Github user asfgit closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/19


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92850783
  
Thank you! (:


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread mar-ia
Github user mar-ia commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92842306
  
Squashed.
@kxepal  Please do :)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread janl
Github user janl commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92795169
  
@kxepal all I meant: I don’t think these are blockers. We can always fix 
them before, too. Sorry for being unclear :)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92777684
  
@mar-ia great! Could you only squash your commits please. If you think it's 
ready, I'll merge it.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread mar-ia
Github user mar-ia commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92767820
  
And already fixed :)
I did some more fixes and some rewrites too, in a try to make things more 
clear.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92764010
  
@janl why not to fix them before? since they are pretty trivial.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-14 Thread janl
Github user janl commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92763742
  
Great work @mar-ia! Let’s get this merged and file issues for the 
line-comments to fix soon after.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-13 Thread kxepal
Github user kxepal commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/19#discussion_r28236027
  
--- Diff: src/cluster/sharding.rst ---
@@ -0,0 +1,289 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may 
not
+.. use this file except in compliance with the License. You may obtain a 
copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations 
under
+.. the License.
+
+.. _cluster/sharding:
+
+
+Sharding
+
+
+.. _cluster/sharding/scaling-out:
+
+Scaling out
+===
+
+Normally you start small and grow over time. In the beginning you might do 
just
+fine with one node, but as your data and number of clients grows, you need 
to
+scale out.
+
+For simplicity we will start fresh and small.
+
+Start node1 and add a database to it. To keep it simple we will have 2 
shards
+and no replicas.
+
+.. code-block:: bash
+
+curl -X PUT "http://xxx.xxx.xxx.xxx:5984/small?n=1&q=2"; --user daboss
+
+If you look in the directory ``data/shards`` you will find the 2 shards.
+
+.. code-block:: text
+
+data
+shards
+-7fff
+small.1425202577.couch
+8000-
+small.1425202577.couch
+
+Now, go to the admin panel
+
+.. code-block:: text
+
+http://xxx.xxx.xxx.xxx:5986/_utils
+
+and look in the database ``_dbs``, it is here that the metadata for each
+database is stored. As the database is called small, there is a document 
called
+small there. Let us look in it. Yes, you can get it with curl too:
+
+.. code-block:: javascript
+
+curl -X GET "http://xxx.xxx.xxx.xxx:5986/_dbs/small";
+
+{
+"_id": "small",
+"_rev": "1-5e2d10c29c70d3869fb7a1fd3a827a64",
+"shard_suffix": [
+46,
+49,
+52,
+50,
+53,
+50,
+48,
+50,
+53,
+55,
+55
+],
+"changelog": [
+[
+"add",
+"-7fff",
+"no...@xxx.xxx.xxx.xxx"
+],
+[
+"add",
+"8000-",
+"no...@xxx.xxx.xxx.xxx"
+]
+],
+"by_node": {
+"no...@xxx.xxx.xxx.xxx": [
+"-7fff",
+"8000-"
+]
+},
+"by_range": {
+"-7fff": [
+"no...@xxx.xxx.xxx.xxx"
+],
+"8000-": [
+"no...@xxx.xxx.xxx.xxx"
+]
+}
+}
+
+* ``_id`` The name of the database.
+* ``_rev`` The current revision of the metadata.
+* ``shard_suffix`` The numbers after small and before .couch. The number of
+  seconds after UNIX epoch that the database was created. Stored in ASCII.
+* ``changelog`` Self explaining. Only for admins to read.
+* ``by_node`` Which shards each node have.
+* ``by_rage`` On which nodes each shard is.
+
+Nothing here, nothing there, a shard in my sleeve
+-
+
+Start node2 and add it to the cluster. Check in ``/_membership`` that the
+nodes are talking with each other.
+
+If you look in the directory ``data`` on node2, you will see that there is 
no
+directory called shards.
+
+Go to Fauxton and edit the metadata for small, so it looks like this:
+
+.. code-block:: javascript
+
+{
+"_id": "small",
+"_rev": "1-5e2d10c29c70d3869fb7a1fd3a827a64",
+"shard_suffix": [
+46,
+49,
+52,
+50,
+53,
+50,
+48,
+50,
+53,
+55,
+ 

[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-13 Thread kxepal
Github user kxepal commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/19#discussion_r28235870
  
--- Diff: src/cluster/setup.rst ---
@@ -0,0 +1,160 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may 
not
+.. use this file except in compliance with the License. You may obtain a 
copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations 
under
+.. the License.
+
+.. _cluster/setup:
+
+=
+Setup
+=
+
+Everything you need to know to prepare the cluster for the installation of
+CouchDB.
+
+Firewall
+
+
+If you do not have a firewall between your servers, then you can skip this.
+
+CouchDB in cluster mode uses the port ``5984`` just as standalone, but is 
also
+uses ``5986`` for the admin interface.
+
+Erlang uses TCP port ``4369`` (EPMD) to find other nodes, so all servers 
must be
+able to speak to each other on this port. In an Erlang Cluster, all nodes 
are
+connected to all other nodes. A mesh.
+
+.. warning::
+Do not open up this port, ``4369`` to the Internet, or any other
+untrusted network. Failing to close this port will leave you wide open!
--- End diff --

Good recommendation. However, you're not very wide opened since cookie is 
required to make a connection.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-13 Thread kxepal
Github user kxepal commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/19#discussion_r28235714
  
--- Diff: src/cluster/nodes.rst ---
@@ -0,0 +1,65 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may 
not
+.. use this file except in compliance with the License. You may obtain a 
copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations 
under
+.. the License.
+
+.. _cluster/nodes:
+
+===
+Node Management
+===
+
+.. _cluster/nodes/add:
+
+Adding a node
+=
+
+Go to ``http://server1:45984/_membership`` to see the name of the node and 
all
+the nodes it knows about and are connected too.
+
+.. code-block:: text
+
+curl -X PUT "http://xxx.xxx.xxx.xxx:5984/_membership"; --user admin-user
--- End diff --

Indeed, `/_membership` [accepts only 
`GET`](https://github.com/apache/couchdb-mem3/blob/master/src/mem3_httpd.erl#L22-L29)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-13 Thread kxepal
Github user kxepal commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/19#discussion_r28235615
  
--- Diff: src/cluster/nodes.rst ---
@@ -0,0 +1,65 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may 
not
+.. use this file except in compliance with the License. You may obtain a 
copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations 
under
+.. the License.
+
+.. _cluster/nodes:
+
+===
+Node Management
+===
+
+.. _cluster/nodes/add:
+
+Adding a node
+=
+
+Go to ``http://server1:45984/_membership`` to see the name of the node and 
all
+the nodes it knows about and are connected too.
+
+.. code-block:: text
+
+curl -X PUT "http://xxx.xxx.xxx.xxx:5984/_membership"; --user admin-user
+
+
{"all_nodes":["no...@xxx.xxx.xxx.xxx"],"cluster_nodes":["nod...@xxx.xxx.xxx.xxx"]}
+
+* ``all_nodes`` are all the nodes thats this node knows about.
+* ``cluster_nodes`` are the nodes that are connected to this node.
+
+To add a node simply do:
+
+.. code-block:: text
+
+curl -X PUT "http://xxx.xxx.xxx.xxx:5986/_nodes/no...@yyy.yyy.yyy.yyy"; 
-d {}
+
+Now look at ``http://server1:5984/_membership`` again.
+
+.. code-block:: text
+
+
{"all_nodes":["mini...@xxx.xxx.xxx.xxx","mini...@yyy.yyy.yyy.yyy"],"cluster_nodes":["mini...@xxx.xxx.xxx.xxx","mini...@yyy.yyy.yyy.yyy"]}
--- End diff --

This example could be pretty printed.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-12 Thread sebastianrothbucher
Github user sebastianrothbucher commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92104794
  
this is just GREAT - definitely +1 on merging it in


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-12 Thread sebastianrothbucher
Github user sebastianrothbucher commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/19#discussion_r28206325
  
--- Diff: src/cluster/nodes.rst ---
@@ -0,0 +1,65 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may 
not
+.. use this file except in compliance with the License. You may obtain a 
copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations 
under
+.. the License.
+
+.. _cluster/nodes:
+
+===
+Node Management
+===
+
+.. _cluster/nodes/add:
+
+Adding a node
+=
+
+Go to ``http://server1:45984/_membership`` to see the name of the node and 
all
+the nodes it knows about and are connected too.
+
+.. code-block:: text
+
+curl -X PUT "http://xxx.xxx.xxx.xxx:5984/_membership"; --user admin-user
--- End diff --

didn't try now - but is it PUT or GET?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: no, you can't use emit() in a ...

2015-04-12 Thread sebastianrothbucher
Github user sebastianrothbucher commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/13#issuecomment-92098618
  
just saw it: I'm +1 on merging...


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-12 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/19#issuecomment-92084051
  
That's great contribution! Again (:


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-12 Thread kxepal
Github user kxepal commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/19#discussion_r28204718
  
--- Diff: src/cluster/sharding.rst ---
@@ -0,0 +1,289 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may 
not
+.. use this file except in compliance with the License. You may obtain a 
copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations 
under
+.. the License.
+
+.. _cluster/sharding:
+
+
+Sharding
+
+
+.. _cluster/sharding/scaling-out:
+
+Scaling out
+===
+
+Normally you start small and grow over time. In the beginning you might do 
just
+fine with one node, but as your data and number of clients grows, you need 
to
+scale out.
+
+For simplicity we will start fresh and small.
+
+Start node1 and add a database to it. To keep it simple we will have 2 
shards
+and no replicas.
+
+.. code-block:: bash
+
+curl -X PUT "http://xxx.xxx.xxx.xxx:5984/small?n=1&q=2"; --user daboss
+
+If you look in the directory ``data/shards`` you will find the 2 shards.
+
+.. code-block:: text
+
+data
+shards
+-7fff
+small.1425202577.couch
+8000-
+small.1425202577.couch
+
+Now, go to the admin panel
+
+.. code-block:: text
+
+http://xxx.xxx.xxx.xxx:5986/_utils
+
+and look in the database ``_dbs``, it is here that the metadata for each
+database is stored. As the database is called small, there is a document 
called
+small there. Let us look in it. Yes, you can get it with curl too:
+
+.. code-block:: javascript
+
+curl -X GET "http://xxx.xxx.xxx.xxx:5986/_dbs/small";
+
+{
+"_id": "small",
+"_rev": "1-5e2d10c29c70d3869fb7a1fd3a827a64",
+"shard_suffix": [
+46,
+49,
+52,
+50,
+53,
+50,
+48,
+50,
+53,
+55,
+55
+],
--- End diff --

bad align


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-12 Thread kxepal
Github user kxepal commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/19#discussion_r28204714
  
--- Diff: src/cluster/sharding.rst ---
@@ -0,0 +1,289 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may 
not
+.. use this file except in compliance with the License. You may obtain a 
copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations 
under
+.. the License.
+
+.. _cluster/sharding:
+
+
+Sharding
+
+
+.. _cluster/sharding/scaling-out:
+
+Scaling out
+===
+
+Normally you start small and grow over time. In the beginning you might do 
just
+fine with one node, but as your data and number of clients grows, you need 
to
+scale out.
+
+For simplicity we will start fresh and small.
+
+Start node1 and add a database to it. To keep it simple we will have 2 
shards
+and no replicas.
+
+.. code-block:: bash
+
+curl -X PUT "http://xxx.xxx.xxx.xxx:5984/small?n=1&q=2"; --user daboss
+
+If you look in the directory ``data/shards`` you will find the 2 shards.
+
+.. code-block:: text
+
+data
--- End diff --

How about to explicitly how here that data, shards and others are 
directories? Like:

```
data/
+-- shards/
 +-- -7fff/
 |   +-- small.1425202577.couch
 +-- 8000-/
 +-- small.1425202577.couch

```


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: A base to build on for 2.0

2015-04-12 Thread mar-ia
GitHub user mar-ia opened a pull request:

https://github.com/apache/couchdb-documentation/pull/19

A base to build on for 2.0

This is basically my couchdb-crazy rep, converted and modified.
The documentation is not done with this, but it is a base to build on.

This is all I have on 2.0, so if anyone wants to fork this branch and 
continue building on it before merging, please do so :)

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/mar-ia/couchdb-documentation cluster

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/19.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #19


commit 856ca85ae8c45c73533fc863ae66dcf21a6f74bd
Author: Maria Andersson 
Date:   2015-04-13T14:47:01Z

A base to build on for 2.0




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Simple grammar fixes to protoc...

2015-04-06 Thread yaronyg
Github user yaronyg commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/18#issuecomment-90133251
  
No problem! Thanks for merging!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Simple grammar fixes to protoc...

2015-04-04 Thread asfgit
Github user asfgit closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/18


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Simple grammar fixes to protoc...

2015-04-04 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/18#issuecomment-89579851
  
Sorry for delay. Merged, thanks a lot! (:


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Small grammar fixes

2015-03-26 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/17#issuecomment-86625833
  
@yaronyg good points. I'll add reference to linter and fix windows support 
as well. Thanks!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Simple grammar fixes to protoc...

2015-03-26 Thread yaronyg
GitHub user yaronyg opened a pull request:

https://github.com/apache/couchdb-documentation/pull/18

Simple grammar fixes to protocol.rst

This time passing the linter 

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/yaronyg/couchdb-documentation master

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/18.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #18


commit 2223f52242306f82eeca90f1334689a2b92f5956
Author: Yaron Y. Goland 
Date:   2015-03-26T17:00:05Z

Simple grammar fixes to protocol.rst




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Small grammar fixes

2015-03-26 Thread yaronyg
Github user yaronyg commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/17#issuecomment-86623716
  
I am running on windows and I tried make.bat doctest from the src directory 
but got a failure because it says "Build name doctest not registered". 
Eventually I figured out how to manually just run "python ext\linter.py src" 
from the MakeFile and that worked. But in any case it would be useful to have a 
link in the style guide that explains how to run the linter.

I'm going to close this PR and submit a separate one from my new repo. I 
fixed all the linter issues so hopefully now it will be fine.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Small grammar fixes

2015-03-26 Thread yaronyg
Github user yaronyg closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/17


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Small grammar fixes

2015-03-25 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/17#issuecomment-86259378
  
You may rebase your PR against current master to let Travis CI check all 
the bits.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Small grammar fixes

2015-03-25 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/17#issuecomment-86249497
  
Thanks a lot for your fixes! However, this change causes breaks [style 
guidlines](https://github.com/apache/couchdb-documentation/blob/master/src/contributing.rst#the-guidelines)
 in many ways.

Here is a full list of problems:

```

/home/kxepal/projects/couchdb/asf/couchdb-documentation/src/replication/protocol.rst
  line 123 : too long (84 > 80) line
Changes Feed, the Replicator doesn't close the connection, but awaits 
new change

  line 144 : too long (81 > 80) line
HTTP endpoints, and run requests with the same parameters to provide a 
completely

  line 148 : too long (81 > 80) line
or Pull Replication. However, while such solutions could also run the 
Replication

  line 250 : trailing whitespace detected!
In case of a non-existent Target, the Replicator MAY make a :put:`/{db}` 

  line 278 : trailing whitespace detected!
:statuscode:`401` or a :statuscode:`403` error. Such errors SHOULD be 
expected 

  line 514 : trailing whitespace detected!
The Replication ID generation algorithm is implementation specific. 
Whatever 

  line 516 : too long (83 > 80) line
Replicator, for example, uses the following factors in generating a 
Replication ID:

  line 538 : too long (82 > 80) line
the Replication Log from both Source and Target using 
:get:`/{db}/_local/{docid}`:

  line 671 : too long (89 > 80) line
then the Replicator MUST determine their common ancestry by following the 
next algorithm:

  line 677 : too long (87 > 80) line
- In case of mismatch, iterate over the ``history`` collection to search 
for the latest

  line 750 : too long (84 > 80) line
the Source's :ref:`Changes Feed ` by using a :get:`/{db}/_changes` 
request.

  line 940 : too long (85 > 80) line
but only for Revisions that do not exist in Target and are REQUIRED to be 
transferred

  line 982 : too long (87 > 80) line
When there are no more changes left to process and no more Documents left 
to replicate,

  line 983 : too long (82 > 80) line
the Replicator finishes the Replication process. If Replication wasn't 
Continuous,

  line 984 : too long (81 > 80) line
the Replicator MAY return a response to client with statistics about the 
process.

  line 1128 : too long (82 > 80) line
To fetch the Document the Replicator will make a :get:`/{db}/{docid}` 
request with

  line 1137 : too long (85 > 80) line
  then the Document MUST be returned for this Revision. Otherwise, Source 
MUST return

  line 1138 : trailing whitespace detected!
  an object with the single field ``missing`` with the missed Revision as 
the value. 

  line 1138 : too long (84 > 80) line
  an object with the single field ``missing`` with the missed Revision as 
the value.

  line 1139 : too long (84 > 80) line
  In case the Document contains attachments, Source MUST return information 
only for

  line 1140 : too long (82 > 80) line
  those ones that had been changed (added or updated) since the specified 
Revision

  line 1141 : too long (83 > 80) line
  values. If an attachment was deleted, the Document MUST NOT have stub 
information

  line 1146 : too long (84 > 80) line
  This parameter solves a race condition problem where the requested 
Document may be

  line 1151 : too long (84 > 80) line
specifies a different mime type. The :mimetype:`multipart/mixed` content 
type allows

  line 1155 : too long (82 > 80) line
encoded strings which are very ineffective for transfer and processing 
operations.

  line 1157 : too long (84 > 80) line
With a :mimetype:`multipart/mixed` response the Replicator handles multiple 
Document

  line 1160 : too long (86 > 80) line
more effective: the Document ALWAYS goes before its attachments, so the 
Replicator has

  line 1161 : too long (83 > 80) line
no need to process all the data to map related Documents-Attachments and 
may handle

  line 1264 : too long (81 > 80) line
stack size could be limited by number of Documents or bytes of handled JSON 
data.

  line 1283 : trailing whitespace detected!
:post:`/{db}/_bulk_docs` request to Target with payload containing a JSON 
object 

  line 1287 : too long (85 > 80) line
  These Documents MUST contain the ``_revisions`` field that holds a list 
of the full

  line 1361 : too long (82 > 80) line
If the Document has been stored successfully, the list item MUST contain 
the field

  line 1365 : too long (81 > 80) line
Document updating f

[GitHub] couchdb-documentation pull request: Small grammar fixes

2015-03-24 Thread yaronyg
GitHub user yaronyg opened a pull request:

https://github.com/apache/couchdb-documentation/pull/17

Small grammar fixes

These are just small, easy, hopefully non-controversial grammar fixes.

The definition of URI refers to RFC 2396. But RFC 2396 is obsolete. It has 
been replaced by RFC 3986.

RFC 2822 has been obsoleted and replaced with RFC 5322

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/yaronyg/couchdb-documentation patch-1

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/17.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #17


commit 6d9cfced9ee0354619e42d9ff51dbccf26d3d3cd
Author: Yaron Y Goland 
Date:   2015-03-24T23:06:18Z

Small grammar fixes

These are just small, easy, hopefully non-controversial grammar fixes.

The definition of URI refers to RFC 2396. But RFC 2396 is obsolete. It has 
been replaced by RFC 3986.

RFC 2822 has been obsoleted and replaced with RFC 5322




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Adjust document ids in queries...

2015-03-22 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/16#issuecomment-84684903
  
Fast and forward, actually (:


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Adjust document ids in queries...

2015-03-22 Thread jo
Github user jo commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/16#issuecomment-84683567
  
That merge was fast :)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


[GitHub] couchdb-documentation pull request: Adjust document ids in queries...

2015-03-22 Thread kxepal
Github user kxepal commented on the pull request:


https://github.com/apache/couchdb-documentation/pull/16#issuecomment-84683120
  
Thank you!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---


  1   2   >