8000 Migrate content from old repo by Simran-B · Pull Request #199 · arangodb/docs-hugo · GitHub
[go: up one dir, main page]

Skip to content

Migrate content from old repo #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
38b16a5
Migrate 3.10, 3.11, and 3.12 content as well as the (shared) images f…
Simran-B Sep 12, 2023
fd69778
[skip ci] Automatic commit of generated files from CircleCI
Sep 12, 2023
8ac95b7
[CircleCI Generated] generate-scheduled-5742 (#200)
arangodb-docs-automation[bot] Sep 12, 2023
1132393
Remove some leading whitespace in code blocks
Simran-B Sep 12, 2023
6958b37
Remove unnecessary ~ from curl code blocks
Simran-B Sep 12, 2023
878958e
Fix indentation of ```js examples
Simran-B Sep 12, 2023
73040f6
Remove pageToc.disable
Simran-B Sep 12, 2023
a252289
Add back horizontal rulers and a conditional text lost in migration, …
Simran-B Sep 13, 2023
9c6b2a2
Apply .fixed layout to two more special tables
Simran-B Sep 13, 2023
18a837b
Use Markdown hard breaks and fix links
Simran-B Sep 13, 2023
219e81b
CSS: Set a bottom instead of top margin for nested lists
Simran-B Sep 13, 2023
31545da
Decrease list indentation, use default bullet points (different per n…
Simran-B Sep 13, 2023
081ea43
Decrease top and bottom margin of admonitions
Simran-B Sep 13, 2023
2ac1386
Merge branch 'main' of https://github.com/arangodb/docs-hugo into mig…
Simran-B Sep 13, 2023
8f824d6
Replace more <br>
Simran-B Sep 13, 2023
1079cb2
Remove api-docs.json and add to ignore list
Simran-B Sep 13, 2023
2bf0257
Merge branch 'main' of https://github.com/arangodb/docs-hugo into mig…
Simran-B Sep 14, 2023
ada3fff
[skip ci] Automatic commit of generated files from CircleCI
Sep 14, 2023
aa55392
Update README
Simran-B Sep 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Use Markdown hard breaks and fix links
Replace <br> with \ at end of line or not do a hard break at all. In tables, <br> is still necessary.
  • Loading branch information
Simran-B committed Sep 13, 2023
commit 18a837bea2e704a92be5239ba36991d8c43525e8
10 changes: 5 additions & 5 deletions site/content/3.10/aql/common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ The above will probably work fine for numeric input values.
What could an attacker do to this query? Here are a few suggestions to use for
the `searchValue` parameter:

- for returning all documents in the collection:<br>
- for returning all documents in the collection:\
`1 || true`
- for removing all documents:<br>
- for removing all documents:\
`1 || true REMOVE doc IN collection //`
- for inserting new documents:<br>
- for inserting new documents:\
`1 || true INSERT { foo: "bar" } IN collection //`

It should have become obvious that this is extremely unsafe and should be
Expand Down Expand Up @@ -324,14 +324,14 @@ the place.

There are two types of bind parameters in AQL:

- Bind parameters for **values**:<br>
- Bind parameters for **values**:\
Those are prefixed with a single `@` in AQL queries, and are specified
without the prefix when they get their value assigned. These bind parameters
can contain any valid JSON value.

Examples: `@what`, `@searchValue`

- Bind parameters for **collections**:<br>
- Bind parameters for **collections**:\
These are prefixed with `@@` in AQL queries, and are replaced with the name
of a collection. When the bind parameter value is assigned, the parameter
itself must be specified with a single `@` prefix. Only string values are
Expand Down
18 changes: 9 additions & 9 deletions site/content/3.10/aql/functions/fulltext.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,25 @@ prefixed with either the `prefix:` or `complete:` qualifier. Different qualifier
be mixed in the same query. Not specifying a qualifier for a search word will implicitly
execute a complete-match search for the given word:

- `FULLTEXT(emails, "body", "banana")`<br>
- `FULLTEXT(emails, "body", "banana")`\
Will look for the word *banana* in the
attribute *body* of the collection *collection*.

- `FULLTEXT(emails, "body", "banana,orange")`<br>
- `FULLTEXT(emails, "body", "banana,orange")`\
Will look for both words
*banana* and *orange* in the mentioned attribute. Only those documents will be
returned that contain both words.

- `FULLTEXT(emails, "body", "prefix:head")`<br>
- `FULLTEXT(emails, "body", "prefix:head")`\
Will look for documents that contain any
words starting with the prefix *head*.

- `FULLTEXT(emails, "body", "prefix:head,complete:aspirin")`<br>
- `FULLTEXT(emails, "body", "prefix:head,complete:aspirin")`\
Will look for all
documents that contain a word starting with the prefix *head* and that also contain
the (complete) word *aspirin*. Note: specifying `complete:` is optional here.

- `FULLTEXT(emails, "body", "prefix:cent,prefix:subst")`<br>
- `FULLTEXT(emails, "body", "prefix:cent,prefix:subst")`\
Will look for all documents
that contain a word starting with the prefix *cent* and that also contain a word
starting with the prefix *subst*.
Expand All @@ -74,19 +74,19 @@ If multiple search words (or prefixes) are given, then by default the results wi
AND-combined, meaning only the logical intersection of all searches will be returned.
It is also possible to combine partial results with a logical OR, and with a logical NOT:

- `FULLTEXT(emails, "body", "+this,+text,+document")`<br>
- `FULLTEXT(emails, "body", "+this,+text,+document")`\
Will return all documents that
contain all the mentioned words. Note: specifying the `+` symbols is optional here.

- `FULLTEXT(emails, "body", "banana,|apple")`<br>
- `FULLTEXT(emails, "body", "banana,|apple")`\
Will return all documents that contain
either (or both) words *banana* or *apple*.

- `FULLTEXT(emails, "body", "banana,-apple")`<br>
- `FULLTEXT(emails, "body", "banana,-apple")`\
Will return all documents that contain
the word *banana*, but do not contain the word *apple*.

- `FULLTEXT(emails, "body", "banana,pear,-cranberry")`<br>
- `FULLTEXT(emails, "body", "banana,pear,-cranberry")`\
Will return all documents that
contain both the words *banana* and *pear*, but do not contain the word
*cranberry*.
Expand Down
2 changes: 1 addition & 1 deletion site/content/3.10/aql/functions/miscellaneous.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ CALL( "SUBSTRING", "this is a test", 0, 4 )

### ASSERT() / WARN()

`ASSERT(expr, message) → retVal`<br>
`ASSERT(expr, message) → retVal`\
`WARN(expr, message) → retVal`

The two functions evaluate an expression. In case the expression evaluates to
Expand Down
4 changes: 2 additions & 2 deletions site/content/3.10/aql/functions/numeric.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ This is an alias for [AVERAGE()](#average).

Return the integer closest but not less than *value*.

To round downward, see [FLOOR()](#floor).<br>
To round downward, see [FLOOR()](#floor).\
To round to the nearest integer value, see [ROUND()](#round).

- **value** (number): any number
Expand Down Expand Up @@ -297,7 +297,7 @@ EXP2(0) // 1

Return the integer closest but not greater than *value*.

To round upward, see [CEIL()](#ceil).<br>
To round upward, see [CEIL()](#ceil).\
To round to the nearest integer value, see [ROUND()](#round).

- **value** (number): any number
Expand Down
10 changes: 5 additions & 5 deletions site/content/3.10/aql/functions/string.md
Original file line number Diff line number Diff line change
Expand Up @@ -702,7 +702,7 @@ RETURN JSON_STRINGIFY( [1, {'2': .5}] )

Return the `n` leftmost characters of the string `value`.

To return the rightmost characters, see [RIGHT()](#right).<br>
To return the rightmost characters, see [RIGHT()](#right).\
To take a part from an arbitrary position off the string,
see [SUBSTRING()](#substring).

Expand Down Expand Up @@ -910,7 +910,7 @@ RETURN LOWER("AVOcado")

Return the string `value` with whitespace stripped from the start only.

To strip from the end only, see [RTRIM()](#rtrim).<br>
To strip from the end only, see [RTRIM()](#rtrim).\
To strip both sides, see [TRIM()](#trim).

- **value** (string): a string
Expand Down Expand Up @@ -1279,7 +1279,7 @@ RETURN REVERSE("电脑坏了")

Return the `length` rightmost characters of the string `value`.

To return the leftmost characters, see [LEFT()](#left).<br>
To return the leftmost characters, see [LEFT()](#left).\
To take a part from an arbitrary position off the string,
see [SUBSTRING()](#substring).

Expand Down Expand Up @@ -1312,7 +1312,7 @@ RETURN RIGHT("foobar", 10)

Return the string `value` with whitespace stripped from the end only.

To strip from the start only, see [LTRIM()](#ltrim).<br>
To strip from the start only, see [LTRIM()](#ltrim).\
To strip both sides, see [TRIM()](#trim).

- **value** (string): a string
Expand Down Expand Up @@ -1647,7 +1647,7 @@ RETURN SUBSTITUTE("the quick brown foxx", {

Return a substring of `value`.

To return the rightmost characters, see [RIGHT()](#right).<br>
To return the rightmost characters, see [RIGHT()](#right).\
To return the leftmost characters, see [LEFT()](#left).

- **value** (string): a string
Expand Down
12 changes: 6 additions & 6 deletions site/content/3.10/deploy/arangosync/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ ArangoDB's _Datacenter-to-Datacenter Replication_ is a solution that enables you
to asynchronously replicate the entire structure and content in an ArangoDB Cluster
in one place to a Cluster in another place. Typically it is used from one datacenter
to another. It is possible to replicate to multiple other datacenters as well.
<br/>It is not a solution for replicating single server instances.
It is not a solution for replicating single server instances.

![ArangoDB DC2DC](../../../images/dc2dc_topology.png)

Expand All @@ -43,12 +43,12 @@ load, network & computer capacity.
_ArangoSync_ performs replication in a **single direction** only. That means that
you can replicate data from cluster _A_ to cluster _B_ or from cluster _B_ to
cluster _A_, but never at the same time (one leader, one or more follower clusters).
<br/>Data modified in the destination cluster **will be lost!**
Data modified in the destination cluster **will be lost!**

Replication is a completely **autonomous** process. Once it is configured it is
designed to run 24/7 without frequent manual intervention.
<br/>This does not mean that it requires no maintenance or attention at all.
<br/>As with any distributed system some attention is needed to monitor its operation
This does not mean that it requires no maintenance or attention at all.
As with any distributed system some attention is needed to monitor its operation
and keep it secure (e.g. certificate & password rotation).

In the event of an outage of the leader cluster, user intervention is required
Expand All @@ -63,7 +63,7 @@ leader by a couple of seconds or minutes.
Once configured, _ArangoSync_ will replicate both **structure and data** of an
**entire cluster**. This means that there is no need to make additional configuration
changes when adding/removing databases or collections.
<br/>Also meta data such as users, Foxx application & jobs are automatically replicated.
Also me F42D ta data such as users, Foxx application & jobs are automatically replicated.

A message queue developed by ArangoDB in Go and called **DirectMQ** is used for
replication. It is tailored for DC2DC replication with efficient native
Expand Down Expand Up @@ -100,7 +100,7 @@ To use _Datacenter-to-Datacenter Replication_ you need the following:

{{< info >}}
In several places you will need a (x509) certificate.
<br/>The [Certificates](security.md#certificates) section provides more guidance for creating
The [Certificates](security.md#certificates) section provides more guidance for creating
and renewing these certificates.
{{< /info >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Below you'll find an overview per component.
- Sync master & workers: The `arangosync` servers running as either master
or worker, provide:
- A status API, see `arangosync get status`. Make sure that all statuses report `running`.
<br/>For even more detail the following commands are also available:
For even more detail the following commands are also available:
`arangosync get tasks`, `arangosync get masters` & `arangosync get workers`.
- A log on the standard output. Log levels can be configured using `--log.level` settings.
- A metrics API `GET /metrics`. This API is compatible with Prometheus.
Expand All @@ -43,7 +43,8 @@ indication that something may be wrong. In case that happens, give it some time
(incremental synchronization may take quite some time for large collections)
and look at the status again. If the statuses do not change (or change, but not reach `running`)
it is time to inspects the metrics & log files.
<br/> When the metrics or logs seem to indicate a problem in a sync master or worker, it is

When the metrics or logs seem to indicate a problem in a sync master or worker, it is
safe to restart it, as long as only 1 instance is restarted at a time.
Give restarted instances some time to "catch up".

Expand Down
36 changes: 23 additions & 13 deletions site/content/3.10/deploy/arangosync/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,14 @@ Below you'll find an overview of these connections and the TCP ports that should
Digital certificates are used in many places in _ArangoSync_ for both encryption
and authentication.

<br/> In ArangoSync all network connections are using Transport Layer Security (TLS),
In ArangoSync all network connections are using Transport Layer Security (TLS),
a set of protocols that ensure that all network traffic is encrypted.
For this TLS certificates are used. The server side of the network connection
offers a TLS certificate. This certificate is (often) verified by the client side of the network
connection, to ensure that the certificate is signed by a trusted Certificate Authority (CA).
This ensures the integrity of the server.
<br/> In several places additional certificates are used for authentication. In those cases

In several places additional certificates are used for authentication. In those cases
the client side of the connection offers a client certificate (on top of an existing TLS connection).
The server side of the connection uses the client certificate to authenticate
the client and (optionally) decides which rights should be assigned to the client.
Expand All @@ -59,24 +60,32 @@ however it is more convenient (and common) to use your own CA.
All certificates are x509 certificates with a public key, a private key and
an optional chain of certificates used to sign the certificate. This chain is
typically provided by the Certificate Authority (CA).
<br/>Depending on their use, certificates stored in a different format.
Depending on their use, certificates stored in a different format.

The following formats are used:

- Public key only (`.crt`): A file that contains only the public key of
a certificate with an optional chain of parent certificates (public keys of certificates
used to signed the certificate).
<br/>Since this format contains only public keys, it is not a problem if its contents

Since this format contains only public keys, it is not a problem if its contents
are exposed. It must still be store it in a safe place to avoid losing it.

- Private key only (`.key`): A file that contains only the private key of a certificate.
<br/>It is vital to protect these files and store them in a safe place.

It is vital to protect these files and store them in a safe place.

- Keyfile with public & private key (`.keyfile`): A file that contains the public key of
a certificate, an optional chain of parent certificates and a private key.
<br/>Since this format also contains a private key, it is vital to protect these files

Since this format also contains a private key, it is vital to protect these files
and store them in a safe place.

- Java keystore (`.jks`): A file containing a set of public and private keys.
<br/>It is possible to protect access to the content of this file using a keystore password.
<br/>Since this format can contain private keys, it is vital to protect these files

It is possible to protect access to the content of this file using a keystore password.

Since this format can contain private keys, it is vital to protect these files
and store them in a safe place (even when its content is protected with a keystore password).

### Creating certificates
Expand Down Expand Up @@ -160,15 +169,16 @@ Therefore even more care is needed to store them safely.

All certificates have meta information in them the limit their use in function,
target & lifetime.
<br/> A certificate created for client authentication (function) cannot be used as a TLS server certificate
(same is true for the reverse).
<br/> A certificate for host `myserver` (target) cannot be used for host `anotherserver`.
<br/> A certificate that is valid until October 2017 (lifetime) cannot be used after October 2017.

- A certificate created for client authentication (function) cannot be used as a
TLS server certificate (same is true for the reverse).
- A certificate for host `myserver` (target) cannot be used for host `anotherserver`.
- A certificate that is valid until October 2017 (lifetime) cannot be used after October 2017.

If anything changes in function, target or lifetime you need a new certificate.

The procedure for creating a renewed certificate is the same as for creating a "first" certificate.
<br/> After creating the renewed certificate the process(es) using them have to be updated.
After creating the renewed certificate the process(es) using them have to be updated.
This mean restarting them. All ArangoSync components are designed to support stopping and starting
single instances, but do not restart more than 1 instance at the same time.
As soon as 1 instance has been restarted, give it some time to "catch up" before restarting
Expand Down
7 changes: 4 additions & 3 deletions site/content/3.10/deploy/arangosync/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Below you'll find an overview per component.
- Sync master & workers: The `arangosync` servers running as either master
or worker, provide:
- A status API, see `arangosync get status`. Make sure that all statuses report `running`.
<br/>For even more detail the following commands are also available:
For even more detail the following commands are also available:
`arangosync get tasks`, `arangosync get masters` & `arangosync get workers`.
- A log on the standard output. Log levels can be configured using `--log.level` settings.
- A metrics API `GET /metrics`. This API is compatible with Prometheus.
Expand All @@ -43,8 +43,9 @@ When not everything is in the `running` state (on both datacenters), this is an
indication that something may be wrong. In case that happens, give it some time
(incremental synchronization may take quite some time for large collections)
and look at the status again. If the statuses do not change (or change, but not reach `running`)
it is time to inspects the metrics & log files.
<br/> When the metrics or logs seem to indicate a problem in a sync master or worker, it is
it is time to inspects the metrics and log files.

When the metrics or logs seem to indicate a problem in a sync master or worker, it is
safe to restart it, as long as only 1 instance is restarted at a time.
Give restarted instances some time to "catch up".

Expand Down
6 changes: 3 additions & 3 deletions site/content/3.10/graphs/smartgraphs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ known, SmartGraphs can make use if it.

Examples for such graphs are:

- **Social Networks**<br>
- **Social Networks**\
Typically the feature here is the region/country users live in. Every user has
more contacts in the same region/country than in other regions/countries.

- **Transport Systems**<br>
- **Transport Systems**\
For transport systems, the common feature is the region/country. There are
many local connections, but only a few go across countries.

- **E-Commerce**<br>
- **E-Commerce**\
In this case, the category of products is a good feature. Products of the same
category are often bought together.

Expand Down
16 changes: 8 additions & 8 deletions site/content/3.10/release-notes/version-3.6/whats-new-in-3-6.md
Original file line number Diff line number Diff line change
Expand Up @@ -457,13 +457,13 @@ In addition, ArangoDB 3.6 provides the following new AQL functionality:
The following optional properties can be provided for an `ngram` Analyzer
definition:

- `startMarker` : `<string>`, default: ""<br>
- `startMarker` : `<string>`, default: ""\
this value will be prepended to _n_-grams at the beginning of input sequence

- `endMarker` : `<string>`, default: ""<br>
- `endMarker` : `<string>`, default: ""\
this value will be appended to _n_-grams at the beginning of input sequence

- `streamType` : `"binary"|"utf8"`, default: "binary"<br>
- `streamType` : `"binary"|"utf8"`, default: "binary"\
type of the input stream (support for UTF-8 is new)

- Added _edge n-gram_ support to the [`text` Analyzer type](../../index-and-search/analyzers.md#text).
Expand Down Expand Up @@ -590,7 +590,7 @@ for details and usage examples.

The following APIs have been expanded / changed:

- [Database creation API](../../develop/http/databases.md#create-a-database),<br>
- [Database creation API](../../develop/http/databases.md#create-a-database),\
HTTP route `POST /_api/database`

The database creation API now handles the `replicationFactor`, `writeConcern`
Expand All @@ -612,26 +612,26 @@ The following APIs have been expanded / changed:
that database via the web UI, arangosh or drivers (unless the startup option
`--cluster.force-one-shard` is enabled).

- [Database properties API](../../develop/http/databases.md#get-information-about-the-current-database),<br>
- [Database properties API](../../develop/http/databases.md#get-information-about-the-current-database),\
HTTP route `GET /_api/database/current`

The database properties endpoint returns the new additional attributes
`replicationFactor`, `writeConcern` and `sharding` in a cluster.
A description of these attributes can be found above.

- [Collection](../../develop/http/collections.md) / [Graph APIs](../../develop/http/graphs/named-graphs.md#management),<br>
- [Collection](../../develop/http/collections.md) / [Graph APIs](../../develop/http/graphs/named-graphs.md#management),\
HTTP routes `POST /_api/collection`, `GET /_api/collection/{collection-name}/properties`
and various `/_api/gharial/*` endpoints

`minReplicationFactor` has been renamed to `writeConcern` for consistency.
The old attribute name is still accepted and returned for compatibility.

- [Hot Backup API](../../develop/http/hot-backups.md#create-a-backup),<br>
- [Hot Backup API](../../develop/http/hot-backups.md#create-a-backup),\
HTTP route `POST /_admin/backup/create`

New attribute `force`, see [Hot Backup](#hot-backup) below.

- New [Metrics API](../../develop/http/monitoring.md#metrics-api),<br>
- New [Metrics API](../../develop/http/monitoring.md#metrics-api),\
HTTP route `GET /_admin/metrics`

Returns the instance's current metrics in Prometheus format. The returned
Expand Down
Loading
0