couchdb-documentation.git
5 years agoTransition to sphinx_rtd_theme (#154)
Joan Touzet [Fri, 28 Jul 2017 04:07:09 +0000 (00:07 -0400)] 
Transition to sphinx_rtd_theme (#154)

5 years agoUpdate for ini file handling under 2.x (#152)
Joan Touzet [Thu, 27 Jul 2017 22:21:23 +0000 (18:21 -0400)] 
Update for ini file handling under 2.x (#152)

5 years agoAdvertise convenience binaries for installation (#153)
Joan Touzet [Thu, 27 Jul 2017 22:10:05 +0000 (18:10 -0400)] 
Advertise convenience binaries for installation (#153)

Closes #141.

5 years agoFind API uses JSON body, not query parameters (#148)
Jonathan Hall [Thu, 27 Jul 2017 22:07:30 +0000 (00:07 +0200)] 
Find API uses JSON body, not query parameters (#148)

Also update the data type for a few fields, and mark `selector` as required.

5 years agoUpdate sharding.rst (#151)
andydonzelli [Thu, 27 Jul 2017 22:06:43 +0000 (23:06 +0100)] 
Update sharding.rst (#151)

* Update sharding.rst

Correcting two instances of "to" should be "too".

* Updating sharding.rst (2)

Fixed a third improper use "to" instead of "too".

5 years agoUpdate 2.1 What's New document (#150)
Joan Touzet [Tue, 25 Jul 2017 18:18:23 +0000 (14:18 -0400)] 
Update 2.1 What's New document (#150)

Closes apache/couchdb#683.

5 years agoPOST /dbname should not return ETag response header (#139)
Robert Newson [Wed, 19 Jul 2017 19:08:29 +0000 (20:08 +0100)] 
POST /dbname should not return ETag response header (#139)

* POST /dbname should not return ETag response header

as it relates to a different resource.

Note: We used to send ETag for this in previous releases, so it's
technically a regression even though we accidentally fix a spec
violation.

Closes #620

* Document loss of ETag in POST as breaking change in 2.0

5 years agoremove blank line at end
Robert Newson [Wed, 19 Jul 2017 18:41:04 +0000 (19:41 +0100)] 
remove blank line at end

5 years agoMerge pull request #146 from apache/fix/cluster-node-delete
Jan Lehnardt [Wed, 19 Jul 2017 18:29:22 +0000 (20:29 +0200)] 
Merge pull request #146 from apache/fix/cluster-node-delete

fix: node doc delete missing ?rev

5 years agoMerge pull request #144 from calonso/patch-1
Jan Lehnardt [Wed, 19 Jul 2017 18:29:02 +0000 (20:29 +0200)] 
Merge pull request #144 from calonso/patch-1

Update confusing note on dd copy operation

5 years agoMerge pull request #147 from apache/remove_per_module_logging
Robert Newson [Wed, 19 Jul 2017 18:20:21 +0000 (19:20 +0100)] 
Merge pull request #147 from apache/remove_per_module_logging

remove 'Per module logging' as the feature is gone in 2.0

5 years agoremove 'Per module logging' as the feature is gone in 2.0 147/head
Robert Newson [Wed, 19 Jul 2017 18:19:05 +0000 (19:19 +0100)] 
remove 'Per module logging' as the feature is gone in 2.0

5 years agofix: node doc delete missing ?rev 146/head
Jan Lehnardt [Wed, 19 Jul 2017 14:34:31 +0000 (16:34 +0200)] 
fix: node doc delete missing ?rev

5 years agoMerge pull request #145 from apache/628-stable-update-stale-mango
Jan Lehnardt [Wed, 19 Jul 2017 14:29:12 +0000 (16:29 +0200)] 
Merge pull request #145 from apache/628-stable-update-stale-mango

feat: document stable/update/stale options for _find

5 years agofeat: document stable/update/stale options for _find 145/head
Jan Lehnardt [Sun, 16 Jul 2017 16:30:11 +0000 (18:30 +0200)] 
feat: document stable/update/stale options for _find

5 years agoRemove trailing whitespaces 144/head
Carlos Alonso [Fri, 14 Jul 2017 22:04:06 +0000 (00:04 +0200)] 
Remove trailing whitespaces

5 years agoUpdate confusing note on dd copy operation
Carlos Alonso [Fri, 14 Jul 2017 10:56:07 +0000 (12:56 +0200)] 
Update confusing note on dd copy operation

5 years agoRemove OAuth documentation
Joan Touzet [Sat, 8 Jul 2017 04:24:04 +0000 (00:24 -0400)] 
Remove OAuth documentation

Helps resolve issue #656

5 years agoMake clear _global_changes DB is optional
Joan Touzet [Wed, 5 Jul 2017 22:00:01 +0000 (18:00 -0400)] 
Make clear _global_changes DB is optional

5 years agoAdd CONTRIBUTING.md
Joan Touzet [Wed, 5 Jul 2017 18:31:53 +0000 (14:31 -0400)] 
Add CONTRIBUTING.md

5 years agocouchapps -> ddocs
Joan Touzet [Wed, 5 Jul 2017 06:20:06 +0000 (02:20 -0400)] 
couchapps -> ddocs

* remove all references to couchapps in the documentation
* include an explanation as to why this change has been made

5 years agoadd X-Frame-Options header documentation (#138)
garren smith [Fri, 30 Jun 2017 12:02:44 +0000 (14:02 +0200)] 
add X-Frame-Options header documentation (#138)

add X-Frame-Options header documentation

5 years agoUpdate mango docs (#137)
garren smith [Thu, 15 Jun 2017 15:26:50 +0000 (17:26 +0200)] 
Update mango docs (#137)

* Update mango docs

Remove some text references and update how index is chosen

* fix from review

5 years agofix very bad typo on node-local port
Joan Touzet [Wed, 14 Jun 2017 23:34:34 +0000 (19:34 -0400)] 
fix very bad typo on node-local port

5 years agoversion bump
Joan Touzet [Fri, 9 Jun 2017 06:39:12 +0000 (02:39 -0400)] 
version bump

5 years agoTrivial change to trigger readthedocs integration
Joan Touzet [Thu, 8 Jun 2017 20:38:58 +0000 (16:38 -0400)] 
Trivial change to trigger readthedocs integration

5 years agoUpdate backwards compatibility change in 2.0 c.f. #559
Joan Touzet [Sat, 3 Jun 2017 06:44:48 +0000 (02:44 -0400)] 
Update backwards compatibility change in 2.0 c.f. #559

5 years agoDocument new couchup utility, improve installation documentation
Joan Touzet [Sun, 28 May 2017 08:09:58 +0000 (04:09 -0400)] 
Document new couchup utility, improve installation documentation

This adds documentation for the new couchup utility. It also reorganizes
the installation documentation order, and includes explicit reminders
in every installation section to follow the first-time setup steps.
We've been getting a LOT of drive-bys on IRC/Slack asking why there are
endless errors about _users and _replicator in the logfiles, and I
suspect it's because that section is buried on the same page as the table
of contents for the installation section.

5 years agoDocument 'filter' field for _replicate endpoint.
Jonathan Hall [Fri, 7 Apr 2017 22:07:51 +0000 (00:07 +0200)] 
Document 'filter' field for _replicate endpoint.

5 years agoCorrecting `meta` parameter documentation
Stefan du Fresne [Mon, 22 May 2017 10:04:49 +0000 (11:04 +0100)] 
Correcting `meta` parameter documentation

5 years agoUpdate documentation to point to GitHub issues for new issues
Joan Touzet [Wed, 17 May 2017 18:54:13 +0000 (14:54 -0400)] 
Update documentation to point to GitHub issues for new issues

5 years agoAdd/update contribution guidelines, issue/PR templates for GH Issues
Joan Touzet [Wed, 17 May 2017 17:57:50 +0000 (13:57 -0400)] 
Add/update contribution guidelines, issue/PR templates for GH Issues

5 years agoUpdate docs related to _scheduler/docs/{db}/{docid} endpoint
Nick Vatamaniuc [Wed, 10 May 2017 01:24:30 +0000 (21:24 -0400)] 
Update docs related to _scheduler/docs/{db}/{docid} endpoint

Document these endpoints:
 * _scheduler/docs/{replicator_db}
 * _scheduler/docs/{replicator_db}/{docid}

Update replicator example due to the API change in how single replicator doc
info is retrieved.

Issue https://github.com/apache/couchdb/issues/506

5 years agoDocumention for the scheduling replicator
Nick Vatamaniuc [Thu, 6 Apr 2017 15:54:16 +0000 (11:54 -0400)] 
Documention for the scheduling replicator

"What's New" update includes feature improvements and also an implicit to 3.0

"Replicator" section describing some new behavior and includes a state transition diagram.

Jira: COUCHDB-3324

5 years agoFix Ubuntu 14.04 build
Joan Touzet [Thu, 27 Apr 2017 07:33:06 +0000 (03:33 -0400)] 
Fix Ubuntu 14.04 build

5 years agoUpdate all references to instance_start_time
Jonathan Hall [Mon, 24 Apr 2017 10:40:53 +0000 (12:40 +0200)] 
Update all references to instance_start_time

Previously, the new behavior (that instance_start_time is always "0") was
mentioned only in one place. This updates it throughout the documentation.

5 years agoAdd links to the detailed feed mode descriptions.
Jonathan Hall [Tue, 18 Apr 2017 18:32:31 +0000 (20:32 +0200)] 
Add links to the detailed feed mode descriptions.

5 years agoUpdate changes feed documentation
Jonathan Hall [Sat, 18 Mar 2017 20:16:23 +0000 (21:16 +0100)] 
Update changes feed documentation

5 years agoUpdate description and examples for _replication_state_time
Jonathan Hall [Tue, 18 Apr 2017 19:05:04 +0000 (21:05 +0200)] 
Update description and examples for _replication_state_time

5 years agoMerge pull request #127 from apache/COUCHDB-3100
Joan Touzet [Tue, 18 Apr 2017 16:55:59 +0000 (12:55 -0400)] 
Merge pull request #127 from apache/COUCHDB-3100

Update documentation for require_valid_user

5 years agoUpdate documentation for require_valid_user COUCHDB-3100 127/head
Joan Touzet [Sat, 15 Apr 2017 18:20:50 +0000 (14:20 -0400)] 
Update documentation for require_valid_user

Fixes COUCHDB-3100

5 years agoMerge pull request #122 from lornajane/mango-additions
Joan Touzet [Thu, 13 Apr 2017 19:39:36 +0000 (15:39 -0400)] 
Merge pull request #122 from lornajane/mango-additions

Additions to _find and _index from original Mango docs PR

5 years agoPatching over additions from original Mango docs PR 122/head
Lorna Jane Mitchell [Wed, 5 Apr 2017 18:36:02 +0000 (19:36 +0100)] 
Patching over additions from original Mango docs PR

5 years agoUpdate docs for PUT attachments
Jonathan Hall [Tue, 4 Apr 2017 14:14:23 +0000 (16:14 +0200)] 
Update docs for PUT attachments

These headers were completely misdocumented, even for Couch 1.6.  But
they've all been removed entirely for Couch 2.0.0, according to my testing.

5 years agoRemove references to all_or_nothing for _bulk_docs
Jonathan Hall [Sun, 2 Apr 2017 23:11:14 +0000 (01:11 +0200)] 
Remove references to all_or_nothing for _bulk_docs

... as this was removed in 2.0.0

5 years agoReally minor changes, to improve the English
Lorna Jane Mitchell [Wed, 29 Mar 2017 14:50:32 +0000 (15:50 +0100)] 
Really minor changes, to improve the English

Fixes a minor to/too typo

5 years agoMerge pull request #54 from shimaore/patch-1
Joan Touzet [Mon, 20 Mar 2017 03:19:35 +0000 (23:19 -0400)] 
Merge pull request #54 from shimaore/patch-1

Use the proper location for `require` example

5 years agoMerge pull request #20 from BigBlueHat/explain-provides
Joan Touzet [Mon, 20 Mar 2017 03:07:32 +0000 (23:07 -0400)] 
Merge pull request #20 from BigBlueHat/explain-provides

Clarify provides() usage in _list function

5 years agono, you can't use emit() in a list function.
Joan Touzet [Mon, 20 Mar 2017 03:06:15 +0000 (23:06 -0400)] 
no, you can't use emit() in a list function.

5 years agoMerge pull request #115 from flimzy/dbupdates
Joan Touzet [Mon, 20 Mar 2017 03:04:04 +0000 (23:04 -0400)] 
Merge pull request #115 from flimzy/dbupdates

Update _db_updates documentation for CouchDB 2.0.0

5 years agoMerge pull request #116 from apache/3329-kill-pdf-texinfo
Joan Touzet [Sun, 19 Mar 2017 23:48:22 +0000 (19:48 -0400)] 
Merge pull request #116 from apache/3329-kill-pdf-texinfo

Remove pdf and info builds from default target

5 years agoDocument deletion approach when using filtered replication
Joan Touzet [Sun, 19 Mar 2017 22:41:32 +0000 (18:41 -0400)] 
Document deletion approach when using filtered replication

Addresses PR #92 and COUCHDB-1893.

5 years agoClarify download link is for docs only
Joan Touzet [Sun, 19 Mar 2017 22:12:41 +0000 (18:12 -0400)] 
Clarify download link is for docs only

5 years agoRemove pdf and info builds from default target 116/head
Joan Touzet [Sun, 19 Mar 2017 06:37:18 +0000 (02:37 -0400)] 
Remove pdf and info builds from default target

5 years agoUpdate _db_updates documentation for CouchDB 2.0.0 115/head
Jonathan Hall [Sat, 18 Mar 2017 19:00:36 +0000 (20:00 +0100)] 
Update _db_updates documentation for CouchDB 2.0.0

5 years agoBring back the correct implementation of max_document_size
Nick Vatamaniuc [Thu, 16 Mar 2017 04:07:02 +0000 (00:07 -0400)] 
Bring back the correct implementation of max_document_size

COUCHDB-2992

5 years agoCorrect response code from /_uuids
Joan Touzet [Fri, 17 Mar 2017 21:29:21 +0000 (17:29 -0400)] 
Correct response code from /_uuids

5 years agoFlesh out the documentation for POST /{db}/_all_docs
Jonathan Hall [Thu, 16 Mar 2017 09:22:28 +0000 (10:22 +0100)] 
Flesh out the documentation for POST /{db}/_all_docs

5 years agoRemove /_log references from the documentation.
Jonathan Hall [Wed, 15 Mar 2017 09:17:11 +0000 (10:17 +0100)] 
Remove /_log references from the documentation.

And add its removal to the whatsnew document.

5 years agoMention /_config move in Whatsnew document
Jonathan Hall [Wed, 15 Mar 2017 09:22:20 +0000 (10:22 +0100)] 
Mention /_config move in Whatsnew document

5 years agoUpdate config examples and other references
Jonathan Hall [Wed, 15 Mar 2017 09:11:10 +0000 (10:11 +0100)] 
Update config examples and other references

5 years agoUpdate _config endpoint documentation to reflect new location
Jonathan Hall [Mon, 13 Mar 2017 19:41:14 +0000 (20:41 +0100)] 
Update _config endpoint documentation to reflect new location

5 years agoRender new options with more emphasis
Jonathan Hall [Thu, 16 Mar 2017 07:47:24 +0000 (08:47 +0100)] 
Render new options with more emphasis

5 years agoFix typo in option
Nick Vatamaniuc [Thu, 16 Mar 2017 03:18:57 +0000 (23:18 -0400)] 
Fix typo in option

5 years agoExpand logging config documentation to include writer-specific parameters.
Jonathan Hall [Mon, 13 Mar 2017 20:52:27 +0000 (21:52 +0100)] 
Expand logging config documentation to include writer-specific parameters.

5 years agoAdd additional logging levels
Jonathan Hall [Mon, 13 Mar 2017 20:38:46 +0000 (21:38 +0100)] 
Add additional logging levels

I'm unsure of proper descriptions, however, so I've left those blank.

5 years agoUpdate logging references in _config section
Jonathan Hall [Mon, 13 Mar 2017 19:36:46 +0000 (20:36 +0100)] 
Update logging references in _config section

5 years agoFix a typo in the markup
Jonathan Hall [Mon, 13 Mar 2017 19:18:15 +0000 (20:18 +0100)] 
Fix a typo in the markup

5 years agoDocument the log.writer option
Jonathan Hall [Mon, 13 Mar 2017 18:53:12 +0000 (19:53 +0100)] 
Document the log.writer option

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

5 years agoUpdate description of GET /{db}/ response fields
Jonathan Hall [Wed, 15 Mar 2017 16:55:24 +0000 (17:55 +0100)] 
Update description of GET /{db}/ response fields

5 years agoUpdate references to `update_seq` to no longer claim it's always a number.
Jonathan Hall [Sat, 4 Mar 2017 10:31:58 +0000 (11:31 +0100)] 
Update references to `update_seq` to no longer claim it's always a number.

In response to the CouchDB 2.0 changes detailed here: http://docs.couchdb.org/en/master/whatsnew/2.0.html#upgrade-notes

5 years agoClarify use of 'rev' query parameter in document PUT
Jonathan Hall [Thu, 9 Mar 2017 10:57:34 +0000 (11:57 +0100)] 
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.

5 years agoMerge pull request #107 from flimzy/deletesession
Nick Vatamaniuc [Mon, 13 Mar 2017 15:47:58 +0000 (11:47 -0400)] 
Merge pull request #107 from flimzy/deletesession

Documentation updates for DELETE /_session

5 years agoExpand documentation for DELETE /_session 107/head
Jonathan Hall [Sun, 12 Mar 2017 18:09:53 +0000 (19:09 +0100)] 
Expand documentation for DELETE /_session

5 years agoDELETE /_session never returns 401
Jonathan Hall [Sun, 12 Mar 2017 18:07:23 +0000 (19:07 +0100)] 
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.

5 years agoMerge branch 'update-max-http-request-size'
Nick Vatamaniuc [Wed, 8 Mar 2017 16:03:30 +0000 (11:03 -0500)] 
Merge branch 'update-max-http-request-size'

Closes #105

5 years agoAdd documentation for the new `max_http_request_size` parameter 105/head
Nick Vatamaniuc [Wed, 8 Mar 2017 15:24:12 +0000 (10:24 -0500)] 
Add documentation for the new `max_http_request_size` parameter

COUCHDB-2992

5 years agoMerge branch 'pr/91'
Nick Vatamaniuc [Wed, 8 Mar 2017 02:48:25 +0000 (21:48 -0500)] 
Merge branch 'pr/91'

Closes #91

5 years agoIndent shell line so it renderes correctly
Nick Vatamaniuc [Wed, 8 Mar 2017 02:45:12 +0000 (21:45 -0500)] 
Indent shell line so it renderes correctly

5 years agoclarify $db/_security section
Robert Kowalski [Thu, 1 Dec 2016 02:08:08 +0000 (03:08 +0100)] 
clarify $db/_security section

 - point out that values are optional
 - add curl example
 - language fixes

5 years agoMerge branch 'pr/104'
Nick Vatamaniuc [Wed, 8 Mar 2017 02:15:28 +0000 (21:15 -0500)] 
Merge branch 'pr/104'

Closes #104

5 years agoShorten line to make linter happy
Nick Vatamaniuc [Wed, 8 Mar 2017 02:15:11 +0000 (21:15 -0500)] 
Shorten line to make linter happy

5 years agoFix description of delayed_commits
Jonathan Hall [Tue, 7 Mar 2017 10:35:26 +0000 (11:35 +0100)] 
Fix description of delayed_commits

- Fix spelling and grammar
- Reword to be less awkward.

5 years agoFix the config option name and descriptions
Jonathan Hall [Mon, 6 Mar 2017 09:59:47 +0000 (10:59 +0100)] 
Fix the config option name and descriptions

- Re-word description of X-Auth-CouchDB-Roles header to be less awkward.  As
  previously worded, it was a list of N items with a single comma, which
  clearly makes no sense.  I reworded it to be less ambiguously a
  comma-separated listed.
- <force token to be required> was formatted as a config option.  Instead, I
  reworded the description to use the acutal config option,
  <proxy_use_secret>,
- Reword description of X-Auth-CouchDB-Token to make it clear that the
  header itself is not optional, but rather that the config option requiring
  it is optional.

5 years agoRemove redundancy
Jonathan Hall [Sat, 4 Mar 2017 10:40:54 +0000 (11:40 +0100)] 
Remove redundancy

5 years agoGrammar improvements
Jonathan Hall [Sat, 25 Feb 2017 18:18:10 +0000 (19:18 +0100)] 
Grammar improvements

5 years agoMerge branch 'pr/98'
Nick Vatamaniuc [Wed, 8 Mar 2017 02:06:40 +0000 (21:06 -0500)] 
Merge branch 'pr/98'

Closes #98

5 years agoRemove extra empty line to pass make check
Nick Vatamaniuc [Wed, 8 Mar 2017 02:06:20 +0000 (21:06 -0500)] 
Remove extra empty line to pass make check

5 years agoAdd erlang-reltool dependency to RHEL/CentOS with warning.
Lars Goldschlager [Thu, 19 Jan 2017 14:50:12 +0000 (10:50 -0400)] 
Add erlang-reltool dependency to RHEL/CentOS with warning.

On RHEL/CentOS erlang-reltool must be installed manually, but it
pulls in many dependencies including X11 libraries, so the dep was
added in a separate step with a warning regarding it's need and deps
and suggesting it be installed in a separate step so that the whole
list of packages can be uninstalled after build using a system tool.

5 years agogcc-c++ required for Jiffy
Lars Goldschlager [Thu, 19 Jan 2017 14:40:07 +0000 (10:40 -0400)] 
gcc-c++ required for Jiffy

To build Jiffy (which is part of the basic release build) in
CentOS (tested on 7.3) the c++ tool which is part of gcc-c++ is
required, gcc-c++ is not pulled in with the rest of the toolchain
deps during the basic dep install so it needs to be included manually.

5 years agoAdd missing dependency for basic build.
Lars Goldschlager [Thu, 19 Jan 2017 14:37:05 +0000 (10:37 -0400)] 
Add missing dependency for basic build.

On CentOS (Tested on 7.3) erlang-erl_interface needs to be explicitly
installed for the build process to even start.

5 years agoMerge branch 'pr/95'
Nick Vatamaniuc [Wed, 8 Mar 2017 02:03:38 +0000 (21:03 -0500)] 
Merge branch 'pr/95'

Closes #95

5 years agoFix line length to make check passes
Nick Vatamaniuc [Wed, 8 Mar 2017 02:03:28 +0000 (21:03 -0500)] 
Fix line length to make check passes

5 years agoGrammar and an inaccuracy.
Lyn Headley [Sat, 17 Dec 2016 14:46:41 +0000 (06:46 -0800)] 
Grammar and an inaccuracy.

5 years agoMerge branch 'pr/102'
Nick Vatamaniuc [Wed, 8 Mar 2017 01:57:31 +0000 (20:57 -0500)] 
Merge branch 'pr/102'

Close #102

5 years agoFix wording & make ines < 80 chars long
Nick Vatamaniuc [Wed, 8 Mar 2017 01:57:11 +0000 (20:57 -0500)] 
Fix wording & make ines < 80 chars long

5 years agoFix Shard documentation: typos, minor clarification on ASCII codes
Rob Porter [Wed, 22 Feb 2017 18:28:08 +0000 (13:28 -0500)] 
Fix Shard documentation: typos, minor clarification on ASCII codes

5 years agoMerge branch 'pr/99'
Nick Vatamaniuc [Wed, 8 Mar 2017 01:42:41 +0000 (20:42 -0500)] 
Merge branch 'pr/99'

Closes #99

5 years agoFix documentation contribution guidelines
Lucas Satabin [Fri, 27 Jan 2017 16:30:11 +0000 (17:30 +0100)] 
Fix documentation contribution guidelines

The documentation site now lives in its own git repository. The
guidelines are outdated.

5 years agoMerge branch 'pr/101'
Nick Vatamaniuc [Wed, 8 Mar 2017 01:40:15 +0000 (20:40 -0500)] 
Merge branch 'pr/101'

Closes #101