You are viewing a plain text version of this content. The canonical link for it is here.

Posted to notifications@couchdb.apache.org by GitBox <gi...@apache.org> on 2020/01/29 18:22:43 UTC

[GitHub] [couchdb-documentation] wohali opened a new pull request #488: Fully remove mention of admin party everywhere

wohali opened a new pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488
 
 
   This attempts to put passwords in all our examples in the intro at least, and remove references to admin party elsewhere.
   
   Ignore the branch name ;)

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [couchdb-documentation] flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere

Posted by GitBox <gi...@apache.org>.

flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488#discussion_r372555205
 
 

 ##########
 File path: src/intro/curl.rst
 ##########
 @@ -16,30 +16,38 @@
 cURL: Your Command Line Friend
 ==============================
 
-The ``curl`` utility is a command line tool available on Unix, Linux,
-Mac OS X and Windows and many other platforms. ``curl`` provides easy
-access to the HTTP protocol (among others) directly from the
-command-line and is therefore an ideal way of interacting with CouchDB
-over the HTTP REST API.
+The ``curl`` utility is a command line tool available on Unix, Linux, Mac OS X
+and Windows and many other platforms. ``curl`` provides easy access to the HTTP
+protocol (among others) directly from the command-line and is therefore an
 
 Review comment:
   ```suggestion
   protocol (among others) directly from the command line and is therefore an
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [couchdb-documentation] wohali commented on a change in pull request #488: Fully remove mention of admin party everywhere

Posted by GitBox <gi...@apache.org>.

wohali commented on a change in pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488#discussion_r372564333

##########
File path: src/intro/security.rst
##########
@@ -130,38 +126,34 @@ the hash.

.. _Bruce Schneier: http://en.wikipedia.org/wiki/Bruce_Schneier

-But what's with the ``-hashed-`` prefix? When CouchDB starts up, it reads a set
-of `.ini` files with config settings. It loads these settings into an internal
-data store (not a database). The config API lets you read the current
-configuration as well as change it and create new entries. CouchDB is writing
-any changes back to the `.ini` files.
+When CouchDB starts up, it reads a set of ``.ini`` files with config settings. It
+loads these settings into an internal data store (not a database). The config
+API lets you read the current configuration as well as change it and create new
+entries. CouchDB is writing any changes back to the ``.ini`` files.

-The `.ini` files can also be edited by hand when CouchDB is not running.
+The ``.ini`` files can also be edited by hand when CouchDB is not running.
Instead of creating the admin user as we showed previously, you could have
-stopped CouchDB, opened your `local.ini`, added ``anna = secret`` to the
+stopped CouchDB, opened your ``local.ini``, added ``anna = secret`` to the
:config:section:`admins`, and restarted CouchDB. Upon reading the new line from
-`local.ini`, CouchDB would run the hashing algorithm and write back the hash to
-`local.ini`, replacing the plain-text password. To make sure CouchDB only hashes
-plain-text passwords and not an existing hash a second time, it prefixes
-the hash with ``-hashed-``, to distinguish between plain-text passwords and
-hashed passwords. This means your plain-text password can't start with the
-characters ``-hashed-``, but that's pretty unlikely to begin with.
+``local.ini``, CouchDB would run the hashing algorithm and write back the hash
+to ``local.ini``, replacing the plain-text password - just as it did for our

Review comment:
> Since the easiest way to include special characters like em dashes or copyright signs in reST is to directly write them as Unicode characters

from https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#source-encoding

so I'll do that!

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services

[GitHub] [couchdb-documentation] flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere

Posted by GitBox <gi...@apache.org>.

flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488#discussion_r372557041

##########
File path: src/intro/security.rst
##########
@@ -130,38 +126,34 @@ the hash.

.. _Bruce Schneier: http://en.wikipedia.org/wiki/Bruce_Schneier

Review comment:
Perhaps this is more clear?

```suggestion
entries. CouchDB writes any changes back to the ``.ini`` files.
```

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services

[GitHub] [couchdb-documentation] wohali merged pull request #488: Fully remove mention of admin party everywhere

Posted by GitBox <gi...@apache.org>.

wohali merged pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488
 
 
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [couchdb-documentation] flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere

Posted by GitBox <gi...@apache.org>.

flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488#discussion_r372554775
 
 

 ##########
 File path: src/intro/curl.rst
 ##########
 @@ -16,30 +16,38 @@
 cURL: Your Command Line Friend
 ==============================
 
-The ``curl`` utility is a command line tool available on Unix, Linux,
-Mac OS X and Windows and many other platforms. ``curl`` provides easy
-access to the HTTP protocol (among others) directly from the
-command-line and is therefore an ideal way of interacting with CouchDB
-over the HTTP REST API.
+The ``curl`` utility is a command line tool available on Unix, Linux, Mac OS X
 
 Review comment:
   Oxford comma FTW?
   
   ```suggestion
   The ``curl`` utility is a command line tool available on Unix, Linux, Mac OS X,
   Windows, and many other platforms.
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [couchdb-documentation] flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere

Posted by GitBox <gi...@apache.org>.

flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488#discussion_r372565504
 
 

 ##########
 File path: src/intro/curl.rst
 ##########
 @@ -16,9 +16,10 @@
 cURL: Your Command Line Friend
 ==============================
 
-The ``curl`` utility is a command line tool available on Unix, Linux, Mac OS X
+The ``curl`` utility is a command line tool available on Unix, Linux, Mac OS X,
+Windows, and many other platforms.
 and Windows and many other platforms. ``curl`` provides easy access to the HTTP
 
 Review comment:
   Oops, "and Windows and many other platforms." got duplicated.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [couchdb-documentation] flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere

Posted by GitBox <gi...@apache.org>.

flimzy commented on a change in pull request #488: Fully remove mention of admin party everywhere
URL: https://github.com/apache/couchdb-documentation/pull/488#discussion_r372557798

##########
File path: src/intro/security.rst
##########
@@ -130,38 +126,34 @@ the hash.

.. _Bruce Schneier: http://en.wikipedia.org/wiki/Bruce_Schneier

Review comment:
I think an emdash is more appropriate here. Not sure if we actually use emdashes elsewhere, though (and come to think of it, I'm not even sure how to create one in a `.rst` file), so maybe just a double dash?

```suggestion
to ``local.ini``, replacing the plain-text password--just as it did for our
```

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services