Added documentation for ORCO-18 #883

cpjulia · 2022-01-26T06:41:09Z

Documentation for arangodb/arangodb#15493

3.10/programs-arangod-log.md

jsteemann · 2022-01-26T14:38:20Z

3.10/programs-arangod-log.md

+as an object. A parameter that was set upon server start can be unset by 
+providing its name as a key and `false` as value. 
+The usage is as in the example:
+`arango.PUT("/_admin/log/structured/", {"database": true, "url": false})`


I think we shouldn't put arango.PUT(...) examples into the docs because this is more or less an internal way of making requests. I think here we should simply refer to the HTTP API to adjust the parameters.
The HTTP API should of course be documented as well, but I think this is missing right now from this PR.

Suggested change

`arango.PUT("/_admin/log/structured/", {"database": true, "url": false})`

`arango.PUT("/_admin/log/structured", {"database": true, "url": false})`

I still think we shouldn't put arango.PUT(...) examples into our docs because this is more or less an internal way of making requests that is not advertised to end users. Really.

Co-authored-by: Jan <jsteemann@users.noreply.github.com>

jsteemann

See my non-addressed review comment.

jsteemann

LGTM

…ORCO-18

ansoboleva · 2022-02-02T09:57:45Z

@Simran-B please fix the error with missing arangod options.

…ORCO-18

Simran-B · 2022-02-03T15:51:31Z

Fixed Netlify builds via #895.

…ORCO-18

cla-bot · 2022-02-08T09:30:26Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Jenkins.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email email@example.com
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

cla-bot · 2022-02-08T09:46:44Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Jenkins.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email email@example.com
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

…ORCO-18

cla-bot · 2022-02-08T10:08:14Z

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Jenkins.
This is most likely caused by a git client misconfiguration; please make sure to:

check if your git client is configured with an email to sign commits git config --list | grep email
If not, set it up using git config --global user.email email@example.com
Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

ansoboleva

reviewed

Content changes merged in 0dab932 were accidentally reverted by 4c6755c (#883)

* Bring back changes done in #878 Content changes merged in 0dab932 were accidentally reverted by 4c6755c (#883) * Redo #952 (with simplification) that was accidentally undone by #954 * Add line breaks before API descriptions Fixes DocuBlock rendering issue. The first list item wasn't rendered if a text started with a list * Update examples for 3.10 in redo-commits-2022-02 at 2022-04-21T11:13:36+02:00 Co-authored-by: Jenkins <jenkins@arangodb.com> Co-authored-by: arangodb-release-bot <anastasia.soboleva@arangodb.com>

Added documentation for ORCO-18

bd4e79c

cla-bot bot added the cla-signed label Jan 26, 2022

cpjulia mentioned this pull request Jan 26, 2022

Feature/orco 18 arangodb/arangodb#15493

Merged

18 tasks

ansoboleva added this to the 3.10 milestone Jan 26, 2022

ansoboleva requested a review from jsteemann January 26, 2022 08:11