Skip to content

Commit

Permalink
Fix(docs): Fix subsection references in docs (#6439)
Browse files Browse the repository at this point in the history
* Fix references in docs

* Fix mutations/language-rdf-types.md reference
  • Loading branch information
vmrajas authored Sep 14, 2020
1 parent 816a08f commit 027db53
Show file tree
Hide file tree
Showing 28 changed files with 65 additions and 65 deletions.
4 changes: 2 additions & 2 deletions wiki/content/clients/raw-http.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ The result:
## Running read-only queries

You can set the query parameter `ro=true` to `/query` to set it as a
[read-only]({{< relref "#read-only-transactions" >}}) query.
[read-only]({{< relref "clients/go.md#read-only-transactions" >}}) query.


```sh
Expand All @@ -333,7 +333,7 @@ $ curl -H "Content-Type: application/graphql+-" -X POST "localhost:8080/query?ro
## Running best-effort queries
You can set the query parameter `be=true` to `/query` to set it as a
[best-effort]({{< relref "#read-only-transactions" >}}) query.
[best-effort]({{< relref "clients/go.md#read-only-transactions" >}}) query.
```sh
Expand Down
2 changes: 1 addition & 1 deletion wiki/content/deploy/cluster-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ In setting up a cluster be sure the check the following.
* Does each instance have a unique ID on startup?
* Has `--bindall=true` been set for networked communication?

See the [Production Checklist]({{< relref "production-checklist.md" >}}) docs for more info.
See the [Production Checklist]({{< relref "deploy/production-checklist.md" >}}) docs for more info.
6 changes: 3 additions & 3 deletions wiki/content/deploy/dgraph-administration.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ This stops the Alpha on which the command is executed and not the entire cluster

## Deleting database

Individual triples, patterns of triples and predicates can be deleted as described in the [query languge docs](/query-language#delete).
Individual triples, patterns of triples and predicates can be deleted as described in the [DQL docs]({{< relref "mutations/delete.md" >}}).

To drop all data, you could send a `DropAll` request via `/alter` endpoint.

Expand All @@ -174,7 +174,7 @@ Doing periodic exports is always a good idea. This is particularly useful if you
2. Ensure it is successful
3. [Shutdown Dgraph]({{< relref "#shutting-down-database" >}}) and wait for all writes to complete
4. Start a new Dgraph cluster using new data directories (this can be done by passing empty directories to the options `-p` and `-w` for Alphas and `-w` for Zeros)
5. Reload the data via [bulk loader]({{< relref "#bulk-loader" >}})
5. Reload the data via [bulk loader]({{< relref "deploy/fast-data-loading.md#bulk-loader" >}})
6. Verify the correctness of the new Dgraph cluster. If all looks good, you can delete the old directories (export serves as an insurance)

These steps are necessary because Dgraph's underlying data format could have changed, and reloading the export avoids encoding incompatibilities.
Expand Down Expand Up @@ -225,7 +225,7 @@ new type name and copy data from old predicate name to new predicate name for al
are affected. Then, you can drop the old types and predicates from DB.

{{% notice "note" %}}
If you are upgrading from v1.0, please make sure you follow the schema migration steps described in [this section](/howto/#schema-types-scalar-uid-and-list-uid).
If you are upgrading from v1.0, please make sure you follow the schema migration steps described in [this section]({{< relref "howto/migrate-dgraph-1-1.md" >}}).
{{% /notice %}}

## Post Installation
Expand Down
6 changes: 3 additions & 3 deletions wiki/content/deploy/dgraph-alpha.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ These HTTP endpoints are deprecated and will be removed in the next release. Ple
{{% /notice %}}

* `/health?all` returns information about the health of all the servers in the cluster.
* `/admin/shutdown` initiates a proper [shutdown]({{< relref "#shutdown" >}}) of the Alpha.
* `/admin/export` initiates a data [export]({{< relref "#export" >}}). The exported data will be
* `/admin/shutdown` initiates a proper [shutdown]({{< relref "deploy/dgraph-administration.md#shutting-down-database" >}}) of the Alpha.
* `/admin/export` initiates a data [export]({{< relref "deploy/dgraph-administration.md#exporting-database" >}}). The exported data will be
encrypted if the alpha instance was configured with an encryption key file.

By default the Alpha listens on `localhost` for admin actions (the loopback address only accessible from the same machine). The `--bindall=true` option binds to `0.0.0.0` and thus allows external connections.
Expand Down Expand Up @@ -81,4 +81,4 @@ Here’s an example of JSON returned from the above query:
- `ongoing`: List of ongoing operations in the background.
- `indexing`: List of predicates for which indexes are built in the background. Read more [here]({{< relref "/query-language/schema.md#indexes-in-background" >}}).

The same information (except `ongoing` and `indexing`) is available from the `/health` and `/health?all` endpoints of Alpha server.
The same information (except `ongoing` and `indexing`) is available from the `/health` and `/health?all` endpoints of Alpha server.
5 changes: 3 additions & 2 deletions wiki/content/deploy/fast-data-loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,8 @@ ending in .rdf, .rdf.gz, .json, and .json.gz will be loaded.
`--format`: Specify file format (rdf or json) instead of getting it from
filenames. This is useful if you need to define a strict format manually.

`--store_xids`: Generate a xid edge for each node. It will store the XIDs (The identifier / Blank-nodes) in an attribute named `xid` in the entity itself. It is useful if you gonna use [External IDs](/mutations#external-ids).
`--store_xids`: Generate a xid edge for each node. It will store the XIDs (The identifier / Blank-nodes) in an attribute named `xid` in the entity itself. It is useful if you gonna
use [External IDs]({{< relref "mutations/external-ids.md" >}}).

`--xidmap` (default: disabled. Need a path): Store xid to uid mapping to a directory. Dgraph will save all identifiers used in the load for later use in other data ingest operations. The mapping will be saved in the path you provide and you must indicate that same path in the next load. It is recommended to use this flag if you have full control over your identifiers (Blank-nodes). Because the identifier will be mapped to a specific UID.

Expand Down Expand Up @@ -320,4 +321,4 @@ higher CPU utilization.
Dgraph alpha instances more evenly.

- The `--shufflers` controls the level of parallelism in the shuffle/reduce
stage. Increasing this increases memory consumption.
stage. Increasing this increases memory consumption.
8 changes: 4 additions & 4 deletions wiki/content/deploy/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title = "Using Kubernetes"
The following section covers running Dgraph with Kubernetes. We have tested Dgraph with Kubernetes versions 1.14 to 1.16 on [GKE](https://cloud.google.com/kubernetes-engine) and versions 1.14 to 1.17 on [EKS](https://aws.amazon.com/eks/).

{{% notice "note" %}}These instructions are for running Dgraph alpha service without TLS configuration.
Instructions for running Dgraph alpha service with TLS refer [TLS instructions]({{< relref "tls-configuration.md" >}}).{{% /notice %}}
Instructions for running Dgraph alpha service with TLS refer [TLS instructions]({{< relref "deploy/tls-configuration.md" >}}).{{% /notice %}}

* Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) which is used to deploy
and manage applications on kubernetes.
Expand Down Expand Up @@ -231,7 +231,7 @@ helm install my-release dgraph/dgraph --set image.tag="v1.2.6"

#### Dgraph Configuration Files

You can supply a dgraph config files (see [Config]({{< relref "config.md" >}})) for alpha and zero with Helm chart configuration values:
You can supply a dgraph config files (see [Config]({{< relref "deploy/config.md" >}})) for alpha and zero with Helm chart configuration values:

```yaml
# my-config-values.yaml
Expand Down Expand Up @@ -363,7 +363,7 @@ upgrade the configuration in multiple steps following the steps below.

#### Upgrade to HA cluster setup

To upgrade to an [HA cluster setup]({{< relref "#ha-cluster-setup" >}}), ensure
To upgrade to an [HA cluster setup]({{< relref "#ha-cluster-setup-using-kubernetes" >}}), ensure
that the shard replication setting is more than 1. When `zero.shardReplicaCount`
is not set to an HA configuration (3 or 5), follow the steps below:

Expand Down Expand Up @@ -661,7 +661,7 @@ configuration to be updated.
## Kubernetes and Bulk Loader
You may want to initialize a new cluster with an existing data set such as data
from the [Dgraph Bulk Loader]({{< relref "#bulk-loader" >}}). You can use [Init
from the [Dgraph Bulk Loader]({{< relref "deploy/fast-data-loading.md#bulk-loader" >}}). You can use [Init
Containers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)
to copy the data to the pod volume before the Alpha process runs.
Expand Down
4 changes: 2 additions & 2 deletions wiki/content/deploy/multi-host-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title = "Multi Host Setup"
### Cluster Setup Using Docker Swarm

{{% notice "note" %}}These instructions are for running Dgraph Alpha without TLS config.
Instructions for running with TLS refer [TLS instructions](#tls-configuration).{{% /notice %}}
Instructions for running with TLS refer [TLS instructions]({{< relref "deploy/tls-configuration.md" >}}).{{% /notice %}}

Here we'll go through an example of deploying 3 Dgraph Alpha nodes and 1 Zero on three different AWS instances using Docker Swarm with a replication factor of 3.

Expand Down Expand Up @@ -261,4 +261,4 @@ docker stack rm dgraph

{{% notice "note" %}}
1. This setup assumes that you are using 6 hosts, but if you are running fewer than 6 hosts then you have to either use different volumes between Dgraph alphas or use `-p` & `-w` to configure data directories.
2. This setup would create and use a local volume called `dgraph_data-volume` on the instances. If you plan to replace instances, you should use remote storage like [cloudstore](https://docs.docker.com/docker-for-aws/persistent-data-volumes) instead of local disk. {{% /notice %}}
2. This setup would create and use a local volume called `dgraph_data-volume` on the instances. If you plan to replace instances, you should use remote storage like [cloudstore](https://docs.docker.com/docker-for-aws/persistent-data-volumes) instead of local disk. {{% /notice %}}
6 changes: 3 additions & 3 deletions wiki/content/deploy/ports-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Dgraph cluster nodes use different ports to communicate over gRPC and HTTP. User
ratel | --Not Used-- | --Not Used-- | 8000


<sup>1</sup>: Dgraph Zero's gRPC-internal port is used for internal communication within the cluster. It's also needed for the [fast data loading]({{< relref "#fast-data-loading" >}}) tools Dgraph Live Loader and Dgraph Bulk Loader.
<sup>1</sup>: Dgraph Zero's gRPC-internal port is used for internal communication within the cluster. It's also needed for the [fast data loading]({{< relref "deploy/fast-data-loading.md" >}}) tools Dgraph Live Loader and Dgraph Bulk Loader.

<sup>2</sup>: Dgraph Zero's HTTP-external port is used for [admin]({{< relref "#more-about-dgraph-zero" >}}) operations. Access to it is not required by clients.
<sup>2</sup>: Dgraph Zero's HTTP-external port is used for [admin]({{< relref "deploy/dgraph-zero.md" >}}) operations. Access to it is not required by clients.

Users have to modify security rules or open firewall ports depending up on their underlying network to allow communication between cluster nodes and between the Dgraph instances themselves and between Dgraph and a client. A general rule is to make *-external (gRPC/HTTP) ports wide open to clients and gRPC-internal ports open within the cluster nodes.

Expand Down Expand Up @@ -74,4 +74,4 @@ Over time, the data would be evenly split across all the groups. So, it's
important to ensure that the number of Dgraph alphas is a multiple of the
replication setting. For e.g., if you set `--replicas=3` in Zero, then run three
Dgraph alphas for no sharding, but 3x replication. Run six Dgraph alphas, for
sharding the data into two groups, with 3x replication.
sharding the data into two groups, with 3x replication.
4 changes: 2 additions & 2 deletions wiki/content/deploy/production-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ We provide sample configs for both [Docker Compose](https://github.com/dgraph-io

{{% load-img "/images/deploy-guide-1.png" "2-node cluster" %}}

Configuration can be set either as command-line flags, environment variables, or in a config file (see [Config]({{< relref "deploy/_index.md#config" >}})).
Configuration can be set either as command-line flags, environment variables, or in a config file (see [Config]({{< relref "deploy/config.md" >}})).

Dgraph Zero:
* The `--my` flag should be set to the address:port (the internal-gRPC port) that will be accessible to the Dgraph Alpha (default: `localhost:5080`).
Expand All @@ -130,7 +130,7 @@ We provide sample configs for both [Docker Compose](https://github.com/dgraph-io

A Dgraph cluster can be configured in a high-availability setup with Dgraph Zero and Dgraph Alpha each set up with peers. These peers are part of Raft consensus groups, which elect a single leader amongst themselves. The non-leader peers are called followers. In the event that the peers cannot communicate with the leader (e.g., a network partition or a machine shuts down), the group automatically elects a new leader to continue.

Configuration can be set either as command-line flags, environment variables, or in a config file (see [Config]({{< relref "deploy/_index.md#config" >}})).
Configuration can be set either as command-line flags, environment variables, or in a config file (see [Config]({{< relref "deploy/config.md" >}})).

In this setup, we assume the following hostnames are set:

Expand Down
4 changes: 2 additions & 2 deletions wiki/content/deploy/single-host-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ We will use [Docker Machine](https://docs.docker.com/machine/overview/). It is a
* [Install Docker Machine](https://docs.docker.com/machine/install-machine/) on your machine.

{{% notice "note" %}}These instructions are for running Dgraph Alpha without TLS config.
Instructions for running with TLS refer [TLS instructions](#tls-configuration).{{% /notice %}}
Instructions for running with TLS refer [TLS instructions]({{< relref "deploy/tls-configuration.md" >}}).{{% /notice %}}

Here we'll go through an example of deploying Dgraph Zero, Alpha and Ratel on an AWS instance.

Expand Down Expand Up @@ -145,4 +145,4 @@ Finally run the command below to start the Zero and Alpha.
docker-compose up -d
```
This would start 3 Docker containers running Dgraph Zero, Alpha and Ratel on the same machine. Docker would restart the containers in case there is any error.
You can look at the logs using `docker-compose logs`.
You can look at the logs using `docker-compose logs`.
6 changes: 3 additions & 3 deletions wiki/content/design-concepts/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Both the terminologies get used interchangeably in our code. Dgraph considers ed
i.e. from `Subject -> Object`. This is the direction that the queries would be run.

{{% notice "tip" %}}Dgraph can automatically generate a reverse edge. If the user wants to run
queries in that direction, they would need to define the [reverse edge](/query-language#reverse-edges)
queries in that direction, they would need to define the [reverse edge]({{< relref "query-language/schema.md#reverse-edges" >}})
as part of the schema.{{% /notice %}}

Internally, the RDF N-Quad gets parsed into this format.
Expand Down Expand Up @@ -157,7 +157,7 @@ Each group should typically be served by at least 3 servers, if available. In th
failure, other servers serving the same group can still handle the load in that case.

## New Server and Discovery
Dgraph cluster can detect new machines allocated to the [cluster](/deploy#cluster),
Dgraph cluster can detect new machines allocated to the [cluster]({{< relref "deploy/cluster-setup.md" >}}),
establish connections, and transfer a subset of existing predicates to it based on the groups served
by the new machine.

Expand Down Expand Up @@ -256,4 +256,4 @@ This avoids having to recreate a new connection every time a network call needs
All data in Dgraph that is stored or transmitted is first converted into byte arrays through
serialization using [Protocol Buffers](https://developers.google.com/protocol-buffers/). When
the result is to be returned to the user, the protocol buffer object is traversed, and the JSON
object is formed.
object is formed.
2 changes: 1 addition & 1 deletion wiki/content/dgraph-compared-to-other-databases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Graph databases optimize internal data representation to be able to do graph ope

### Language

Dgraph supports [GraphQL+-]({{< relref "query-language/_index.md#graphql">}}),
Dgraph supports [GraphQL+-]({{< relref "query-language/graphql-fundamentals.md">}}),
a variation of [GraphQL](https://graphql.org/), a query language created by
Facebook.
GraphQL+-, as GraphQL itself, allows results to be produced as subgraph rather than lists.
Expand Down
2 changes: 1 addition & 1 deletion wiki/content/mutations/batch-mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Each mutation may contain multiple RDF triples. For large data uploads many such
```sh
dgraph live --help
```
See also [Fast Data Loading](/deploy#fast-data-loading).
See also [Fast Data Loading]({{< relref "deploy/fast-data-loading.md" >}}).
4 changes: 2 additions & 2 deletions wiki/content/mutations/json-mutation-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ All edges for a predicate emanating from a single node can be deleted at once
If no predicates are specified, then all of the node's known outbound edges (to
other nodes and to literal values) are deleted (corresponding to deleting `S *
*`). The predicates to delete are derived using the type system. Refer to the
[RDF format]({{< relref "#delete" >}}) documentation and the section on the
[RDF format]({{< relref "mutations/delete.md" >}}) documentation and the section on the
[type system]({{< relref "query-language/type-system.md" >}}) for more
information:

Expand Down Expand Up @@ -609,4 +609,4 @@ cat data.json | jq '{set: .}'
}
]
}
```
```
2 changes: 1 addition & 1 deletion wiki/content/mutations/language-rdf-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ The supported [RDF datatypes](https://www.w3.org/TR/rdf11-concepts/#section-Data
| &#60;http&#58;//www.w3.org/2001/XMLSchema#float&#62; | `float` |


See the section on [RDF schema types]({{< relref "#rdf-types" >}}) to understand how RDF types affect mutations and storage.
See the section on [RDF schema types]({{< relref "query-language/schema.md#rdf-types" >}}) to understand how RDF types affect mutations and storage.
4 changes: 2 additions & 2 deletions wiki/content/mutations/upsert-block.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ curl -H "Content-Type: application/json" -X POST localhost:8080/mutate?commitNow
```

If we want to execute the mutation only when the user exists, we could use
[Conditional Upsert]({{< relref "#conditional-upsert" >}}).
[Conditional Upsert]({{< relref "mutations/conditional-upsert.md" >}}).

## Example of `val` Function

Expand Down Expand Up @@ -292,4 +292,4 @@ curl -H "Content-Type: application/json" -X POST localhost:8080/mutate?commitNow
"age": null
}
}' | jq
```
```
2 changes: 1 addition & 1 deletion wiki/content/query-language/aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Schema Types:
| `min` / `max` | `int`, `float`, `string`, `dateTime`, `default` |
| `sum` / `avg` | `int`, `float` |

Aggregation can only be applied to [value variables]({{< relref "#value-variables">}}). An index is not required (the values have already been found and stored in the value variable mapping).
Aggregation can only be applied to [value variables]({{< relref "query-language/value-variables.md">}}). An index is not required (the values have already been found and stored in the value variable mapping).

An aggregation is applied at the query block enclosing the variable definition. As opposed to query variables and value variables, which are global, aggregation is computed locally. For example:
```
Expand Down
6 changes: 3 additions & 3 deletions wiki/content/query-language/count.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Query Example: The number of films acted in by each actor with `Orlando` in thei
}
{{< /runnable >}}

Count can be used at root and [aliased]({{< relref "#alias">}}).
Count can be used at root and [aliased]({{< relref "query-language/alias.md" >}}).

Query Example: Count of directors who have directed more than five films. When used at the query root, the [count index]({{< relref "#count-index">}}) is required.
Query Example: Count of directors who have directed more than five films. When used at the query root, the [count index]({{< relref "query-language/schema.md#count-index" >}}) is required.

{{< runnable >}}
{
Expand All @@ -39,7 +39,7 @@ Query Example: Count of directors who have directed more than five films. When
{{< /runnable >}}


Count can be assigned to a [value variable]({{< relref "#value-variables">}}).
Count can be assigned to a [value variable]({{< relref "query-language/value-variables.md">}}).

Query Example: The actors of Ang Lee's "Eat Drink Man Woman" ordered by the number of movies acted in.

Expand Down
Loading

0 comments on commit 027db53

Please sign in to comment.