Skip to content

Commit

Permalink
Fixed github links with the appropriate url
Browse files Browse the repository at this point in the history
  • Loading branch information
rkarthik007 committed Sep 17, 2019
1 parent 9c719fe commit 3c8635a
Show file tree
Hide file tree
Showing 232 changed files with 935 additions and 935 deletions.
18 changes: 9 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# YugaByte DB Docs
# Yugabyte DB Docs

This repository contains the documentation for YugaByte DB available at https://docs.yugabyte.com/
This repository contains the documentation for Yugabyte DB available at https://docs.yugabyte.com/

Please [open an issue](https://github.com/YugaByte/docs/issues) to suggest enhancements.
Please [open an issue](https://github.com/yugabyte/docs/issues) to suggest enhancements.


# Contributing to YugaByte DB Docs
# Contributing to Yugabyte DB Docs

YugaByte DB docs are based on the Hugo framework and use the Material Docs theme.
Yugabyte DB docs are based on the Hugo framework and use the Material Docs theme.

* Hugo framework: http://gohugo.io/overview/introduction/
* Material Docs theme: http://themes.gohugo.io/material-docs/
Expand All @@ -24,7 +24,7 @@ Follow these steps if this is the first time you are setting up for working on t

Add the original repository as an upstream remote:
```sh
git remote add --track master upstream https://github.com/YugaByte/yugabyte-db.git
git remote add --track master upstream https://github.com/yugabyte/yugabyte-db.git
```

1. Install Hugo. For example, on a Mac, you can run the following commands:
Expand Down Expand Up @@ -110,16 +110,16 @@ instructions just as a reference for YCQL._
### Generate API syntax diagrams

1. Download the latest RRDiagram JAR file (`rrdiagram.jar`). You can find it on the [release
page](https://github.com/YugaByte/RRDiagram/releases/), or you can try running the following
page](https://github.com/yugabyte/RRDiagram/releases/), or you can try running the following
command.

```sh
wget $(curl -s https://api.github.com/repos/YugaByte/RRDiagram/releases/latest \
wget $(curl -s https://api.github.com/repos/Yugabyte/RRDiagram/releases/latest \
| grep browser_download_url | cut -d \" -f 4)
```

_Note: Alternatively, you can manually build the jar file as described in the [build
section](https://github.com/YugaByte/RRDiagram/README.md#build) of the `RRDiagram` repo (and
section](https://github.com/yugabyte/RRDiagram/README.md#build) of the `RRDiagram` repo (and
move/rename the resulting jar from the target folder)._

1. Run the diagram generator using the following command:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/admin/cqlsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ showAsideToc: true

## Download

cqlsh is installed as part of Yugabyte DB and is located in the `bin` directory of YugaByte home. It is also available for download and install from YugaByte DB's [GitHub repo](https://github.com/YugaByte/cqlsh/releases).
cqlsh is installed as part of Yugabyte DB and is located in the `bin` directory of YugaByte home. It is also available for download and install from YugaByte DB's [GitHub repo](https://github.com/yugabyte/cqlsh/releases).

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/content/latest/api/ysql/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Finally, connect to the cluster with `ysqlsh` and run the `CREATE EXTENSION` sta
{{< note title="Note" >}}

Only some extensions are currently supported.
If you encounter any problems with installing or using a particular extension please post an issue on our [GitHub](https://github.com/Yugabyte/yugabyte-db/issues).
If you encounter any problems with installing or using a particular extension please post an issue on our [GitHub](https://github.com/yugabyte/yugabyte-db/issues).

{{< /note >}}

Expand Down Expand Up @@ -322,7 +322,7 @@ This might take a couple of minutes.

{{< note title="Note" >}}

YSQL does not yet support GiST indexes. This is tracked in [this GitHub issue](https://github.com/Yugabyte/yugabyte-db/issues/1337).
YSQL does not yet support GiST indexes. This is tracked in [this GitHub issue](https://github.com/yugabyte/yugabyte-db/issues/1337).

{{< /note >}}

Expand Down
4 changes: 2 additions & 2 deletions docs/content/latest/benchmark/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ For this benchmark, we will setup a 3-node cluster with a replication factor of

### Benchmark tool

We will use the `yb-sample-apps.jar` tool to perform this benchmark. You can get it from [this GitHub repository](https://github.com/Yugabyte/yb-sample-apps) as shown below.
We will use the `yb-sample-apps.jar` tool to perform this benchmark. You can get it from [this GitHub repository](https://github.com/yugabyte/yb-sample-apps) as shown below.

```sh
$ wget https://github.com/Yugabyte/yb-sample-apps/releases/download/v1.2.0/yb-sample-apps.jar?raw=true -O yb-sample-apps.jar
$ wget https://github.com/yugabyte/yb-sample-apps/releases/download/v1.2.0/yb-sample-apps.jar?raw=true -O yb-sample-apps.jar
```

You would need to install java in order to run this tool. Also export the environment variable $ENDPOINTS containing the IP addresses (plus port) for the nodes of the cluster.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/benchmark/ycsb.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ You can setup Yugabyte-cqlsh by doing the following:

```sh
cd $HOME
git clone https://github.com/Yugabyte/cqlsh
git clone https://github.com/yugabyte/cqlsh
```

## Step 5. Prepare the driver script
Expand Down
8 changes: 4 additions & 4 deletions docs/content/latest/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ menu:
weight: 2900
---

We are big believers in open source. [Yugabyte DB](https://github.com/YugaByte/yugabyte-db) is distributed under the Apache v2.0 license, which is very permissive open source license. We value external contributions and fully welcome them! We accept contributions as GitHub pull requests. This page contains everything you need to get you going quickly.
We are big believers in open source. [Yugabyte DB](https://github.com/yugabyte/yugabyte-db) is distributed under the Apache v2.0 license, which is very permissive open source license. We value external contributions and fully welcome them! We accept contributions as GitHub pull requests. This page contains everything you need to get you going quickly.

## Learn about the architecture

Expand All @@ -34,7 +34,7 @@ This is the C++ code and the unit tests that comprise the core of Yugabyte DB. Y

### Docs

[Yugabyte DB documentation](/) uses the Hugo framework. There are two types of docs issues - infrastructure enhancements and adding content. You can [follow the steps outlined here](https://github.com/YugaByte/docs) to run a local version of the docs site. Next, look at the [contributing guide](https://github.com/YugaByte/docs/blob/master/CONTRIBUTING.md) to make your changes and contribute them.
[Yugabyte DB documentation](/) uses the Hugo framework. There are two types of docs issues - infrastructure enhancements and adding content. You can [follow the steps outlined here](https://github.com/yugabyte/docs) to run a local version of the docs site. Next, look at the [contributing guide](https://github.com/YugaByte/docs/blob/master/CONTRIBUTING.md) to make your changes and contribute them.

## Find an issue

Expand All @@ -50,9 +50,9 @@ Issues are tagged with other useful labels as described below.
| `new feature` | An new feature does not exist. New features can be complex additions to the existing system, or standalone pieces. |
| `question` | A question that needs to be answered. |

* If you are just starting out contributing to Yugabyte DB, first off welcome and thanks! Look for issues labelled [good first issue](https://github.com/YugaByte/yugabyte-db/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
* If you are just starting out contributing to Yugabyte DB, first off welcome and thanks! Look for issues labelled [good first issue](https://github.com/yugabyte/yugabyte-db/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).

* If you have already contributed and are familiar, then look for issues with the [help wanted](https://github.com/Yugabyte/yugabyte-db/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label.
* If you have already contributed and are familiar, then look for issues with the [help wanted](https://github.com/yugabyte/yugabyte-db/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label.

{{< note title="Note" >}}
If you want to work on a feature and are not sure which feature to pick, or how to proceed with the one you picked - do not hesitate to ask for help in our [Slack chat](https://www.yugabyte.com/slack) or our [community forum](https://forum.yugabyte.com/).
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/contribute/core-database/checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ showAsideToc: true

## Step 1. Build the source

* First, clone [the Yugabyte DB GitHub repo](https://github.com/YugaByte/yugabyte-db).
* First, clone [the Yugabyte DB GitHub repo](https://github.com/yugabyte/yugabyte-db).
* Next, [build the source code](../build-from-src).
* Optionally, you may want to [run the unit tests](../run-unit-tests).

Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/deploy/kubernetes/local-ssd/gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ service "yb-tservers" created
statefulset "yb-tserver" created
```

You can see the [yaml file to launch a Yugabyte DB kubernetes universe on nodes with local disks](https://github.com/YugaByte/yugabyte-db/blob/master/cloud/kubernetes/yugabyte-statefulset-local-ssd-gke.yaml).
You can see the [yaml file to launch a Yugabyte DB kubernetes universe on nodes with local disks](https://github.com/yugabyte/yugabyte-db/blob/master/cloud/kubernetes/yugabyte-statefulset-local-ssd-gke.yaml).

Note the following `nodeSelector` snippet in the yaml file which instructs the Kubernetes scheduler to place the Yugabyte pods on nodes that have local disks:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/deploy/public-clouds/aws/terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Common commands:

## 1. Create a terraform config file

Create a terraform config file called `yugabyte-db-config.tf` and add following details to it. The terraform module can be found in the [terraform-aws-yugabyte github repository](https://github.com/Yugabyte/terraform-aws-yugabyte).
Create a terraform config file called `yugabyte-db-config.tf` and add following details to it. The terraform module can be found in the [terraform-aws-yugabyte github repository](https://github.com/yugabyte/terraform-aws-yugabyte).

```sh
provider "aws" {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Common commands:

## 1. Create a terraform config file

Create a terraform config file called `yugabyte-db-config.tf` and add following details to it. The terraform module can be found in the [terraform-azure-yugabyte github repository](https://github.com/Yugabyte/terraform-azure-yugabyte).
Create a terraform config file called `yugabyte-db-config.tf` and add following details to it. The terraform module can be found in the [terraform-azure-yugabyte github repository](https://github.com/yugabyte/terraform-azure-yugabyte).

```sh
provider "azurerm" {
Expand Down
4 changes: 2 additions & 2 deletions docs/content/latest/develop/binary/run-sample-apps.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Yugastore-java](https://github.com/Yugabyte/yugastore-java) app is an end-to-end ecommerce application built using a microservices design pattern. React UI, Spring Boot app framework and YugaByte DB (both YSQL and YCQL) are used as the underlying technology stack.
[Yugastore-java](https://github.com/yugabyte/yugastore-java) app is an end-to-end ecommerce application built using a microservices design pattern. React UI, Spring Boot app framework and YugaByte DB (both YSQL and YCQL) are used as the underlying technology stack.

## 1. Create cluster

Expand All @@ -13,7 +13,7 @@ Clients can now connect to the YSQL API at `localhost:5433` and YCQL API at `loc

Clone the repo.
```sh
$ git clone https://github.com/Yugabyte/yugastore-java.git
$ git clone https://github.com/yugabyte/yugastore-java.git
```
```sh
$ cd yugastore-java
Expand Down
4 changes: 2 additions & 2 deletions docs/content/latest/develop/docker/run-sample-apps.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Yugastore](https://github.com/Yugabyte/yugastore) app is a sample ecommerce application built using a microservices design pattern. React UI, Node.js Express app framework and YugaByte DB (YCQL and YEDIS) are used as the underlying technology stack.
[Yugastore](https://github.com/yugabyte/yugastore) app is a sample ecommerce application built using a microservices design pattern. React UI, Node.js Express app framework and YugaByte DB (YCQL and YEDIS) are used as the underlying technology stack.

## 1. Create a cluster

Expand Down Expand Up @@ -34,7 +34,7 @@ Now you can observe the effects of the read/write operations generated by the lo

## 5. Review Yugastore architecture and code

Details of Yugastore architecture are documented [here](../../develop/realworld-apps/ecommerce-app/). Source code is available in the [Yugastore GitHub repo](https://github.com/Yugabyte/yugastore).
Details of Yugastore architecture are documented [here](../../develop/realworld-apps/ecommerce-app/). Source code is available in the [Yugastore GitHub repo](https://github.com/yugabyte/yugastore).

## 6. Run IoT Fleet Management app

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ isTocNested: true
showAsideToc: true
---

In this tutorial, we are going to use the [Kafka Connect-based Sink Connector for Yugabyte DB](https://github.com/YugaByte/yb-kafka-connector) to store events from Apache Kafka into YugaByte DB using YugaByte DB's [YCQL](../../../api/ycql) API.
In this tutorial, we are going to use the [Kafka Connect-based Sink Connector for Yugabyte DB](https://github.com/yugabyte/yb-kafka-connector) to store events from Apache Kafka into YugaByte DB using YugaByte DB's [YCQL](../../../api/ycql) API.

## 1. Start local cluster

Expand Down Expand Up @@ -53,7 +53,7 @@ Clone the git `yb-kafka-connector` git repo.

```sh
$ cd ~/yb-kafka
$ git clone https://github.com/Yugabyte/yb-kafka-connector.git
$ git clone https://github.com/yugabyte/yb-kafka-connector.git
$ cd yb-kafka-connector/
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ It reads data from a table with sentences — by default, it generates an input

To look at the source code, you can check:

- the source file in our GitHub source repo [here](https://github.com/Yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraSparkWordCount.java)
- the source file in our GitHub source repo [here](https://github.com/yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraSparkWordCount.java)
- untar the jar `java/yb-sample-apps-sources.jar` in the download bundle

Most of the logic is in the `run()` method of the `CassandraSparkWordCount` class (in the file `src/main/java/com/yugabyte/sample/apps/CassandraSparkWordCount.java`). Some of the key portions of the sample program are explained in the sections below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ $ wget https://raw.githubusercontent.com/Yugabyte/yb-sql-workshop/master/query-u
### Download the sample data

```sh
$ wget https://github.com/Yugabyte/yb-sql-workshop/raw/master/query-using-bi-tools/sample-data.tgz
$ wget https://github.com/yugabyte/yb-sql-workshop/raw/master/query-using-bi-tools/sample-data.tgz
```

```sh
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/develop/graphql/hasura.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ docker run -d -p 8080:8080 \
hasura/graphql-engine:v1.0.0-beta.6
```

The `HASURA_GRAPHQL_TX_ISOLATION` setting is a temporary requirement due to a Yugabyte DB issue involving the locking of foreign keys ([GitHub issue #1199](https://github.com/YugaByte/yugabyte-db/issues/1199)).
The `HASURA_GRAPHQL_TX_ISOLATION` setting is a temporary requirement due to a Yugabyte DB issue involving the locking of foreign keys ([GitHub issue #1199](https://github.com/yugabyte/yugabyte-db/issues/1199)).

{{< note title="Note" >}}

Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/develop/graphql/prisma.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If Yugabyte DB is installed, run the following `yb-ctl create` command to start

{{< note title="Note" >}}

Setting the transaction isolation level to `serializable` is a temporary limitation due to a Yugabyte DB issue involving the locking of foreign keys ([GitHub issue #1199](https://github.com/YugaByte/yugabyte-db/issues/1199))
Setting the transaction isolation level to `serializable` is a temporary limitation due to a Yugabyte DB issue involving the locking of foreign keys ([GitHub issue #1199](https://github.com/yugabyte/yugabyte-db/issues/1199))

{{< /note >}}

Expand Down
4 changes: 2 additions & 2 deletions docs/content/latest/develop/kubernetes/run-sample-apps.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Yugastore](https://github.com/Yugabyte/yugastore) app is a sample ecommerce application built using a microservices design pattern. React UI, Node.js Express app framework and YugaByte DB (YCQL and YEDIS) are used as the underlying technology stack.
[Yugastore](https://github.com/yugabyte/yugastore) app is a sample ecommerce application built using a microservices design pattern. React UI, Node.js Express app framework and YugaByte DB (YCQL and YEDIS) are used as the underlying technology stack.

## 1. Create a cluster

Expand Down Expand Up @@ -91,7 +91,7 @@ The above output is the Admin UI URL and visiting the Tablet Servers page there

## 5. Review Yugastore architecture and code

Details of Yugastore architecture are documented [here](../realworld-apps/ecommerce-app/). Source code is available in the [Yugastore GitHub repo](https://github.com/Yugabyte/yugastore).
Details of Yugastore architecture are documented [here](../realworld-apps/ecommerce-app/). Source code is available in the [Yugastore GitHub repo](https://github.com/yugabyte/yugastore).

## 6. Run IoT Fleet Management app

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Usage:
```


Browse the [Java source code for the batch application](https://github.com/Yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraTransactionalKeyValue.java) to see how everything fits together.
Browse the [Java source code for the batch application](https://github.com/yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraTransactionalKeyValue.java) to see how everything fits together.


## Example with cqlsh
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/develop/learn/ycql/batch-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ Usage:
```


Browse the [Java source code for the batch application](https://github.com/Yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraBatchKeyValue.java) to see how everything fits together.
Browse the [Java source code for the batch application](https://github.com/yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraBatchKeyValue.java) to see how everything fits together.
2 changes: 1 addition & 1 deletion docs/content/latest/develop/learn/ycql/reads-writes.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Usage:
```


Browse the [Java source code for the batch application](https://github.com/Yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraKeyValue.java) to see how everything fits together.
Browse the [Java source code for the batch application](https://github.com/yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraKeyValue.java) to see how everything fits together.
2 changes: 1 addition & 1 deletion docs/content/latest/develop/learn/ycql/timeseries-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ You can find a working example of using transactions with Yugabyte in our [sampl
```


Browse the [Java source code for the batch application](https://github.com/Yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraTimeseries.java) to see how everything fits together.
Browse the [Java source code for the batch application](https://github.com/yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraTimeseries.java) to see how everything fits together.
2 changes: 1 addition & 1 deletion docs/content/latest/develop/learn/ycql/ttl-data-expiry.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ You can find a working example of using transactions with Yugabyte in our [sampl
```


Browse the [Java source code for the batch application](https://github.com/Yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraStockTicker.java) to see how everything fits together.
Browse the [Java source code for the batch application](https://github.com/yugabyte/yugabyte-db/blob/master/java/yb-loadtester/src/main/java/com/yugabyte/sample/apps/CassandraStockTicker.java) to see how everything fits together.
Loading

0 comments on commit 3c8635a

Please sign in to comment.