You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by va...@apache.org on 2022/09/09 04:26:49 UTC

[couchdb] 01/01: Merge pull request #4164 from apache/integrate-docs-2

This is an automated email from the ASF dual-hosted git repository.

vatamane pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit ae948725c053cef443df61d22e81ec09edec0ede
Merge: 0481ace8e 1907b0bd4
Author: Nick Vatamaniuc <ni...@users.noreply.github.com>
AuthorDate: Fri Sep 9 00:26:42 2022 -0400

    Merge pull request #4164 from apache/integrate-docs-2
    
    Integrate docs into the main repo

 .gitignore                                       |    1 -
 build-aux/Jenkinsfile.pr                         |  122 +-
 rebar.config.script                              |    4 +-
 src/docs/.gitignore                              |   11 +
 src/docs/LICENSE                                 | 2269 ++++++++++++++++++
 src/docs/Makefile                                |   75 +
 src/docs/NOTICE                                  |   31 +
 src/docs/README.md                               |   31 +
 src/docs/ext/configdomain.py                     |  113 +
 src/docs/ext/github.py                           |   46 +
 src/docs/ext/httpdomain.py                       |  712 ++++++
 src/docs/ext/linter.py                           |  293 +++
 src/docs/images/23379351593_0c480537de_q.jpg     |  Bin 0 -> 15822 bytes
 src/docs/images/TLS-Handshake.png                |  Bin 0 -> 153385 bytes
 src/docs/images/epub-icon.png                    |  Bin 0 -> 19185 bytes
 src/docs/images/fair-enough.png                  |  Bin 0 -> 49634 bytes
 src/docs/images/favicon.ico                      |  Bin 0 -> 15086 bytes
 src/docs/images/futon-createdb.png               |  Bin 0 -> 76194 bytes
 src/docs/images/futon-editdoc.png                |  Bin 0 -> 52733 bytes
 src/docs/images/futon-editeddoc.png              |  Bin 0 -> 56005 bytes
 src/docs/images/futon-overview.png               |  Bin 0 -> 50815 bytes
 src/docs/images/futon-replform.png               |  Bin 0 -> 52223 bytes
 src/docs/images/gf-gnome-rainbows.png            |  Bin 0 -> 73847 bytes
 src/docs/images/intro-consistency-01.png         |  Bin 0 -> 38005 bytes
 src/docs/images/intro-consistency-02.png         |  Bin 0 -> 48145 bytes
 src/docs/images/intro-consistency-03.png         |  Bin 0 -> 17333 bytes
 src/docs/images/intro-consistency-04.png         |  Bin 0 -> 13744 bytes
 src/docs/images/intro-consistency-05.png         |  Bin 0 -> 25592 bytes
 src/docs/images/intro-consistency-06.png         |  Bin 0 -> 56651 bytes
 src/docs/images/intro-consistency-07.png         |  Bin 0 -> 53634 bytes
 src/docs/images/intro-tour-01.png                |  Bin 0 -> 50815 bytes
 src/docs/images/intro-tour-03.png                |  Bin 0 -> 53795 bytes
 src/docs/images/intro-tour-04.png                |  Bin 0 -> 56470 bytes
 src/docs/images/intro-tour-05.png                |  Bin 0 -> 53778 bytes
 src/docs/images/intro-tour-06.png                |  Bin 0 -> 61296 bytes
 src/docs/images/intro-tour-07.png                |  Bin 0 -> 67121 bytes
 src/docs/images/intro-tour-08.png                |  Bin 0 -> 83494 bytes
 src/docs/images/intro-tour-09.png                |  Bin 0 -> 84701 bytes
 src/docs/images/intro-tour-10.png                |  Bin 0 -> 61631 bytes
 src/docs/images/intro-why-01.png                 |  Bin 0 -> 25755 bytes
 src/docs/images/intro-why-02.png                 |  Bin 0 -> 5937 bytes
 src/docs/images/intro-why-03.png                 |  Bin 0 -> 5134 bytes
 src/docs/images/logo.png                         |  Bin 0 -> 14092 bytes
 src/docs/images/purge-checkpoint-docs.png        |  Bin 0 -> 77925 bytes
 src/docs/images/replication-state-diagram.svg    |  419 ++++
 src/docs/images/rev-tree1.png                    |  Bin 0 -> 13910 bytes
 src/docs/images/rev-tree2.png                    |  Bin 0 -> 19104 bytes
 src/docs/images/rev-tree3.png                    |  Bin 0 -> 10439 bytes
 src/docs/images/views-intro-01.png               |  Bin 0 -> 1026767 bytes
 src/docs/images/views-intro-02.png               |  Bin 0 -> 9758 bytes
 src/docs/images/views-intro-03.png               |  Bin 0 -> 12650 bytes
 src/docs/images/views-intro-04.png               |  Bin 0 -> 14537 bytes
 src/docs/make.bat                                |  253 +++
 src/docs/rebar.config                            |   16 +
 src/docs/requirements.txt                        |    3 +
 src/docs/rfcs/001-fdb-revision-metadata-model.md |  215 ++
 src/docs/rfcs/002-shard-splitting.md             |  373 +++
 src/docs/rfcs/003-fdb-seq-index.md               |  244 ++
 src/docs/rfcs/004-document-storage.md            |  251 ++
 src/docs/rfcs/005-all-docs-index.md              |  207 ++
 src/docs/rfcs/006-mango-fdb.md                   |  149 ++
 src/docs/rfcs/007-background-jobs.md             |  347 +++
 src/docs/rfcs/008-map-indexes.md                 |  243 ++
 src/docs/rfcs/009-exunit.md                      |  122 +
 src/docs/rfcs/011-opentracing.md                 |  236 ++
 src/docs/rfcs/012-fdb-reduce.md                  | 1096 +++++++++
 src/docs/rfcs/013-node-types.md                  |  143 ++
 src/docs/rfcs/014-pagination.md                  |  215 ++
 src/docs/rfcs/015-background-index-building.md   |  131 ++
 src/docs/rfcs/016-fdb-replicator.md              |  384 ++++
 src/docs/rfcs/017-fair-share-scheduling.md       |  210 ++
 src/docs/rfcs/images/SkExample1.png              |  Bin 0 -> 17085 bytes
 src/docs/rfcs/images/SkExample2.png              |  Bin 0 -> 44835 bytes
 src/docs/rfcs/images/SkExample3.png              |  Bin 0 -> 47555 bytes
 src/docs/rfcs/template.md                        |   85 +
 src/docs/src/about.rst                           |   24 +
 src/docs/src/api/basics.rst                      |  605 +++++
 src/docs/src/api/database/bulk-api.rst           | 1009 +++++++++
 src/docs/src/api/database/changes.rst            |  760 +++++++
 src/docs/src/api/database/common.rst             |  468 ++++
 src/docs/src/api/database/compact.rst            |  246 ++
 src/docs/src/api/database/find.rst               | 1425 ++++++++++++
 src/docs/src/api/database/index.rst              |   47 +
 src/docs/src/api/database/misc.rst               |  504 ++++
 src/docs/src/api/database/security.rst           |  189 ++
 src/docs/src/api/database/shard.rst              |  223 ++
 src/docs/src/api/ddoc/common.rst                 |  221 ++
 src/docs/src/api/ddoc/index.rst                  |   35 +
 src/docs/src/api/ddoc/render.rst                 |  413 ++++
 src/docs/src/api/ddoc/rewrites.rst               |  192 ++
 src/docs/src/api/ddoc/search.rst                 |  168 ++
 src/docs/src/api/ddoc/views.rst                  |  918 ++++++++
 src/docs/src/api/document/attachments.rst        |  315 +++
 src/docs/src/api/document/common.rst             | 1215 ++++++++++
 src/docs/src/api/document/index.rst              |   23 +
 src/docs/src/api/index.rst                       |   42 +
 src/docs/src/api/local.rst                       |  255 +++
 src/docs/src/api/partitioned-dbs.rst             |  231 ++
 src/docs/src/api/server/authn.rst                |  471 ++++
 src/docs/src/api/server/common.rst               | 2648 ++++++++++++++++++++++
 src/docs/src/api/server/configuration.rst        |  324 +++
 src/docs/src/api/server/index.rst                |   26 +
 src/docs/src/best-practices/documents.rst        |  349 +++
 src/docs/src/best-practices/forms.rst            |  143 ++
 src/docs/src/best-practices/index.rst            |   32 +
 src/docs/src/best-practices/iso-date.rst         |   64 +
 src/docs/src/best-practices/jsdevel.rst          |   48 +
 src/docs/src/best-practices/reverse-proxies.rst  |  315 +++
 src/docs/src/best-practices/views.rst            |   57 +
 src/docs/src/cluster/databases.rst               |   85 +
 src/docs/src/cluster/index.rst                   |   39 +
 src/docs/src/cluster/nodes.rst                   |   89 +
 src/docs/src/cluster/purging.rst                 |  185 ++
 src/docs/src/cluster/sharding.rst                |  888 ++++++++
 src/docs/src/cluster/theory.rst                  |   75 +
 src/docs/src/cluster/tls_erlang_distribution.rst |  122 +
 src/docs/src/cluster/troubleshooting.rst         |  115 +
 src/docs/src/conf.py                             |  121 +
 src/docs/src/config/auth.rst                     |  389 ++++
 src/docs/src/config/cluster.rst                  |  126 +
 src/docs/src/config/compaction.rst               |  167 ++
 src/docs/src/config/couch-peruser.rst            |   71 +
 src/docs/src/config/couchdb.rst                  |  232 ++
 src/docs/src/config/http.rst                     |  684 ++++++
 src/docs/src/config/index.rst                    |   35 +
 src/docs/src/config/indexbuilds.rst              |   67 +
 src/docs/src/config/intro.rst                    |  177 ++
 src/docs/src/config/ioq.rst                      |  109 +
 src/docs/src/config/logging.rst                  |  153 ++
 src/docs/src/config/misc.rst                     |  359 +++
 src/docs/src/config/query-servers.rst            |  270 +++
 src/docs/src/config/replicator.rst               |  309 +++
 src/docs/src/config/resharding.rst               |  108 +
 src/docs/src/contributing.rst                    |  218 ++
 src/docs/src/cve/2010-0009.rst                   |   53 +
 src/docs/src/cve/2010-2234.rst                   |   61 +
 src/docs/src/cve/2010-3854.rst                   |   55 +
 src/docs/src/cve/2012-5641.rst                   |   75 +
 src/docs/src/cve/2012-5649.rst                   |   49 +
 src/docs/src/cve/2012-5650.rst                   |   68 +
 src/docs/src/cve/2014-2668.rst                   |   52 +
 src/docs/src/cve/2017-12635.rst                  |   67 +
 src/docs/src/cve/2017-12636.rst                  |   54 +
 src/docs/src/cve/2018-11769.rst                  |   60 +
 src/docs/src/cve/2018-17188.rst                  |   67 +
 src/docs/src/cve/2018-8007.rst                   |   58 +
 src/docs/src/cve/2020-1955.rst                   |   60 +
 src/docs/src/cve/2021-38295.rst                  |   58 +
 src/docs/src/cve/2022-24706.rst                  |   65 +
 src/docs/src/cve/index.rst                       |   73 +
 src/docs/src/ddocs/ddocs.rst                     |  905 ++++++++
 src/docs/src/ddocs/index.rst                     |   47 +
 src/docs/src/ddocs/search.rst                    | 1054 +++++++++
 src/docs/src/ddocs/views/collation.rst           |  264 +++
 src/docs/src/ddocs/views/index.rst               |   29 +
 src/docs/src/ddocs/views/intro.rst               |  740 ++++++
 src/docs/src/ddocs/views/joins.rst               |  431 ++++
 src/docs/src/ddocs/views/nosql.rst               |  529 +++++
 src/docs/src/ddocs/views/pagination.rst          |  267 +++
 src/docs/src/docs.app.src                        |   18 +
 src/docs/src/experimental.rst                    |   40 +
 src/docs/src/fauxton/index.rst                   |   21 +
 src/docs/src/fauxton/install.rst                 |   83 +
 src/docs/src/index.rst                           |   59 +
 src/docs/src/install/docker.rst                  |   43 +
 src/docs/src/install/freebsd.rst                 |   86 +
 src/docs/src/install/index.rst                   |   31 +
 src/docs/src/install/kubernetes.rst              |   35 +
 src/docs/src/install/mac.rst                     |   82 +
 src/docs/src/install/search.rst                  |  111 +
 src/docs/src/install/snap.rst                    |   47 +
 src/docs/src/install/troubleshooting.rst         |  358 +++
 src/docs/src/install/unix.rst                    |  453 ++++
 src/docs/src/install/upgrading.rst               |   83 +
 src/docs/src/install/windows.rst                 |  104 +
 src/docs/src/intro/api.rst                       |  747 ++++++
 src/docs/src/intro/consistency.rst               |  443 ++++
 src/docs/src/intro/curl.rst                      |  145 ++
 src/docs/src/intro/index.rst                     |   52 +
 src/docs/src/intro/overview.rst                  |  361 +++
 src/docs/src/intro/security.rst                  |  530 +++++
 src/docs/src/intro/tour.rst                      |  409 ++++
 src/docs/src/intro/why.rst                       |  300 +++
 src/docs/src/json-structure.rst                  |  693 ++++++
 src/docs/src/maintenance/backups.rst             |   90 +
 src/docs/src/maintenance/compaction.rst          |  358 +++
 src/docs/src/maintenance/index.rst               |   21 +
 src/docs/src/maintenance/performance.rst         |  326 +++
 src/docs/src/partitioned-dbs/index.rst           |  396 ++++
 src/docs/src/query-server/erlang.rst             |  136 ++
 src/docs/src/query-server/index.rst              |   37 +
 src/docs/src/query-server/javascript.rst         |  278 +++
 src/docs/src/query-server/protocol.rst           | 1060 +++++++++
 src/docs/src/replication/conflicts.rst           |  787 +++++++
 src/docs/src/replication/index.rst               |   37 +
 src/docs/src/replication/intro.rst               |  140 ++
 src/docs/src/replication/protocol.rst            | 1898 ++++++++++++++++
 src/docs/src/replication/replicator.rst          |  837 +++++++
 src/docs/src/setup/cluster.rst                   |  373 +++
 src/docs/src/setup/index.rst                     |   27 +
 src/docs/src/setup/single-node.rst               |   57 +
 src/docs/src/whatsnew/0.10.rst                   |  143 ++
 src/docs/src/whatsnew/0.11.rst                   |  349 +++
 src/docs/src/whatsnew/0.8.rst                    |  175 ++
 src/docs/src/whatsnew/0.9.rst                    |  263 +++
 src/docs/src/whatsnew/1.0.rst                    |  269 +++
 src/docs/src/whatsnew/1.1.rst                    |  170 ++
 src/docs/src/whatsnew/1.2.rst                    |  235 ++
 src/docs/src/whatsnew/1.3.rst                    |  258 +++
 src/docs/src/whatsnew/1.4.rst                    |   62 +
 src/docs/src/whatsnew/1.5.rst                    |   60 +
 src/docs/src/whatsnew/1.6.rst                    |   72 +
 src/docs/src/whatsnew/1.7.rst                    |  117 +
 src/docs/src/whatsnew/2.0.rst                    |  151 ++
 src/docs/src/whatsnew/2.1.rst                    |  454 ++++
 src/docs/src/whatsnew/2.2.rst                    |  343 +++
 src/docs/src/whatsnew/2.3.rst                    |  316 +++
 src/docs/src/whatsnew/3.0.rst                    |  706 ++++++
 src/docs/src/whatsnew/3.1.rst                    |  147 ++
 src/docs/src/whatsnew/3.2.rst                    |  336 +++
 src/docs/src/whatsnew/index.rst                  |   41 +
 src/docs/static/css/rtd_theme.css                |   60 +
 src/docs/templates/layout.html                   |   55 +
 src/docs/templates/pages/download.html           |   48 +
 src/docs/templates/pages/index.html              |  195 ++
 225 files changed, 50695 insertions(+), 11 deletions(-)