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 05:44:10 UTC
[couchdb] 01/01: Replace references to old docs repo
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch replace-links-to-old-docs-repo
in repository https://gitbox.apache.org/repos/asf/couchdb.git
commit 5d2bfa9ccd113d3bc01aa01f3c112ee98228eb2b
Author: Nick Vatamaniuc <va...@apache.org>
AuthorDate: Fri Sep 9 01:43:31 2022 -0400
Replace references to old docs repo
---
.github/PULL_REQUEST_TEMPLATE.md | 2 +-
CONTRIBUTING.md | 6 +++---
src/docs/rfcs/008-map-indexes.md | 2 +-
src/docs/rfcs/013-node-types.md | 2 +-
src/docs/rfcs/016-fdb-replicator.md | 12 ++++++------
src/docs/src/contributing.rst | 14 +++++++-------
6 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 0d3aef603..bc26f36e0 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -32,4 +32,4 @@
- [ ] Code is written and works correctly
- [ ] Changes are covered by tests
- [ ] Any new configurable parameters are documented in `rel/overlay/etc/default.ini`
-- [ ] A PR for documentation changes has been made in https://github.com/apache/couchdb-documentation
+- [ ] Documentation changes were been made in the `src/docs` folder
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d575067bc..da4595b79 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -199,7 +199,7 @@ If you never created a pull request before, welcome :tada: :smile:
the project’s README for more information.
4. If you added or changed a feature, make sure to document it accordingly in
- the [CouchDB documentation][14] repository.
+ the [documentation][14] directory.
5. Push your topic branch up to our repo
@@ -320,7 +320,7 @@ some commit message conventions.
[11]: mailto:security@couchdb.apache.org?subject=Security
[12]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[13]: https://help.github.com/fork-a-repo
-[14]: https://github.com/apache/couchdb-documentation
+[14]: https://github.com/apache/couchdb/tree/main/src/docs
[15]: https://help.github.com/articles/using-pull-requests
[16]: https://help.github.com/articles/about-two-factor-authentication
[17]: https://gitbox.apache.org/setup
@@ -329,4 +329,4 @@ some commit message conventions.
[#gh_issues]: https://github.com/apache/couchdb/issues
[#gh_hoodie]: https://github.com/hoodiehq/hoodie
-[#gh_hub]: https://hub.github.com
\ No newline at end of file
+[#gh_hub]: https://hub.github.com
diff --git a/src/docs/rfcs/008-map-indexes.md b/src/docs/rfcs/008-map-indexes.md
index b10c4d7d7..49704faac 100644
--- a/src/docs/rfcs/008-map-indexes.md
+++ b/src/docs/rfcs/008-map-indexes.md
@@ -165,7 +165,7 @@ In CouchDB 2.x, strings are compared via ICU. The way to do this with Foundation
### Index building
-An index will be built and updated via a [background job worker](https://github.com/apache/couchdb-documentation/blob/main/rfcs/007-background-jobs.md). When a request for a view is received, the request process will add a job item onto the background queue for the index to be updated. A worker will take the item off the queue and update the index. Once the index has been built, the background job server will notify the request that the index is up to date. The request process will then [...]
+An index will be built and updated via a [background job worker](https://github.com/apache/couchdb/blob/main/src/docs/rfcs/007-background-jobs.md). When a request for a view is received, the request process will add a job item onto the background queue for the index to be updated. A worker will take the item off the queue and update the index. Once the index has been built, the background job server will notify the request that the index is up to date. The request process will then read [...]
Initially, the building of an index will be a single worker running through the changes feed and creating the index. In the future, we plan to parallelise that work so that multiple workers could build the index at the same time. This will reduce build times.
diff --git a/src/docs/rfcs/013-node-types.md b/src/docs/rfcs/013-node-types.md
index 5cd3adc75..fc5059834 100644
--- a/src/docs/rfcs/013-node-types.md
+++ b/src/docs/rfcs/013-node-types.md
@@ -135,7 +135,7 @@ N/A
[1] https://github.com/apache/couchdb/issues/1338
-[2] https://github.com/apache/couchdb-documentation/blob/main/rfcs/007-background-jobs.md
+[2] https://github.com/apache/couchdb/blob/main/src/docs/rfcs/007-background-jobs.md
# Acknowledgments
diff --git a/src/docs/rfcs/016-fdb-replicator.md b/src/docs/rfcs/016-fdb-replicator.md
index af66c209e..7f9c7363d 100644
--- a/src/docs/rfcs/016-fdb-replicator.md
+++ b/src/docs/rfcs/016-fdb-replicator.md
@@ -21,11 +21,11 @@ CouchDB <= 3.x, replication jobs were mapped to individual cluster nodes and a
scheduler component would run up to `max_jobs` number of jobs at a time on each
node. The new design proposes using `couch_jobs`, as described in the
[Background Jobs
-RFC](https://github.com/apache/couchdb-documentation/blob/main/rfcs/007-background-jobs.md),
+RFC](https://github.com/apache/couchdb/blob/main/src/docs/rfcs/007-background-jobs.md),
to have a central, FDB-based queue of replication jobs. `couch_jobs`
application will manage job scheduling and coordination. The new design also
proposes using heterogeneous node types as defined in the [Node Types
-RFC](https://github.com/apache/couchdb-documentation/blob/main/rfcs/013-node-types.md)
+RFC](https://github.com/apache/couchdb/blob/main/src/docs/rfcs/013-node-types.md)
such that replication jobs will be created only on `api_frontend` nodes and run
only on `replication` nodes.
@@ -58,12 +58,12 @@ changes feed, then stop.
`api_frontend node` : Database node which has the `api_frontend` type set to
`true` as described in
-[RFC](https://github.com/apache/couchdb-documentation/blob/main/rfcs/013-node-types.md).
+[RFC](https://github.com/apache/couchdb/blob/main/src/docs/rfcs/013-node-types.md).
Replication jobs can be only be created on these nodes.
`replication node` : Database node which has the `replication` type set to
`true` as described in
-[RFC](https://github.com/apache/couchdb-documentation/blob/main/rfcs/013-node-types.md).
+[RFC](https://github.com/apache/couchdb/blob/main/src/docs/rfcs/013-node-types.md).
Replication jobs can only be run on these nodes.
`filtered` replications: Replications with a user-defined filter on the source
@@ -369,9 +369,9 @@ traffic sent out only from those nodes.
# References
-* [Background Jobs RFC](https://github.com/apache/couchdb-documentation/blob/main/rfcs/007-background-jobs.md)
+* [Background Jobs RFC](https://github.com/apache/couchdb/blob/main/src/docs/rfcs/007-background-jobs.md)
-* [Node Types RFC](https://github.com/apache/couchdb-documentation/blob/main/rfcs/013-node-types.md)
+* [Node Types RFC](https://github.com/apache/couchdb/blob/main/src/docs/rfcs/013-node-types.md)
* [CouchDB 3.x replicator implementation](https://github.com/apache/couchdb/blob/3.x/src/couch_replicator/README.md)
diff --git a/src/docs/src/contributing.rst b/src/docs/src/contributing.rst
index 17f66d569..7d2bc4148 100644
--- a/src/docs/src/contributing.rst
+++ b/src/docs/src/contributing.rst
@@ -24,16 +24,16 @@ If you don't have a GitHub account yet, it is a good time to get one, they are
free. If you don't want to use GitHub, there are alternate ways to
contributing back, that we'll cover next time.
-Go to https://github.com/apache/couchdb-documentation and click the "fork"
+Go to https://github.com/apache/couchdb and click the "fork"
button in the top right. This will create a fork of CouchDB in your GitHub
account. If your account is `username`, your fork lives at
-https://github.com/username/couchdb-documentation. In the header, it tells me my
+https://github.com/username/couchdb. In the header, it tells me my
"GitHub Clone URL". We need to copy that and start a terminal:
.. code-block:: bash
- $ git clone https://github.com/username/couchdb-documentation.git
- $ cd couchdb-documentation
+ $ git clone https://github.com/username/couchdb.git
+ $ cd couchdb/src/docs
$ subl .
I'm opening the whole CouchDB documentation source tree in my favourite editor.
@@ -57,8 +57,8 @@ It gives me the usual directory listing:
themes/
.travis.yml
-The documentation sources live in `src`, you can safely ignore all
-the other files and directories.
+The documentation sources live in `src/docs/src`, you can safely
+ignore all the other files and directories.
First we should determine where we want to document this inside the
documentation. We can look through http://docs.couchdb.org/en/latest/
@@ -149,7 +149,7 @@ Then we push the commit to our CouchDB fork::
$ git push origin main
Next, we go back to our GitHub page
-https://github.com/username/couchdb-documentation and click the "Pull Request"
+https://github.com/username/couchdb and click the "Pull Request"
button. Fill in the description with something useful and hit the
"Send Pull Request" button.