Skip to content
This repository has been archived by the owner on Dec 15, 2021. It is now read-only.

Commit

Permalink
Fix docs relative links (#686)
Browse files Browse the repository at this point in the history
  • Loading branch information
andresmgot authored Apr 11, 2018
1 parent 30fd75e commit e07f0f7
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ We would love to get your help, feel free to lend a hand. We are currently looki

Meeting notes and agenda can be found [here](https://docs.google.com/document/d/1-OsikjjQVHVFoXBHUbkRogrzzZijQ9MumFpLfWCCjwk/edit). Meeting records can be found [here](https://www.youtube.com/user/bitrock5/)

**Slack**: We're fairly active on [slack](http://slack.oss.bitnami.com) and you can find us in the #kubeless channel.
**Slack**: We're fairly active on [slack](http://slack.k8s.io) and you can find us in the #kubeless channel.
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ A _Trigger_ represents an event source the functions associated to it. When an e

### Runtime

A _Runtime_ represents language and runtime specific environment in which function will be executed. Please see [runtimes](./runtimes.md) for more details.
A _Runtime_ represents language and runtime specific environment in which function will be executed. Please see [runtimes](/docs/runtimes) for more details.

## Design

Expand Down
2 changes: 1 addition & 1 deletion docs/dev-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ git push origin myfeature

### Updating generated files

There are several files that are automatically generated by Kubernetes [code-generator](https://github.com/kubernetes/code-generator) based on the API [specification](./pkg/apis/kubeless/) in the repository.
There are several files that are automatically generated by Kubernetes [code-generator](https://github.com/kubernetes/code-generator) based on the API [specification](https://github.com/kubeless/kubeless/tree/master/pkg/apis/kubeless) in the repository.

These include:

Expand Down
2 changes: 1 addition & 1 deletion docs/implementing-new-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The HTTP server should satisfy the following requirements:
- The port used to expose the service can be modified using an environment variable `FUNC_PORT`.
- The server should return `200 - OK` to requests at `/healthz`.
- Functions should run `FUNC_TIMEOUT` as maximum. If, due to language limitations, it is not possible not stop the user function, at least a `408 - Timeout` response should be returned to the HTTP request.
- Functions should receive two parameters: `event` and `context` and should return the value that will be used as HTTP response. See [the functions standard signature](./runtimes#runtimes-interface) for more information. The information that will be available in `event` parameter will be received as HTTP headers.
- Functions should receive two parameters: `event` and `context` and should return the value that will be used as HTTP response. See [the functions standard signature](/docs/runtimes#runtimes-interface) for more information. The information that will be available in `event` parameter will be received as HTTP headers.
- Requests should be served in parallel.
- Requests should be logged to stdout including date, HTTP method, requested path and status code of the reponse.
- Exceptions in the function should be catched. The server should not exit due to a function error.
Expand Down
6 changes: 3 additions & 3 deletions docs/kubeless-on-azure-container-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ In order to get Kubeless up and running on top of ACS of course you'll need an A

## 3. Installing "Kubeless-Controller"

Assuming that the Kubernetes cluster is up and running on top of ACS, its time to install kubeless-controller on master VM. To accomplish, please, follow the steps described on Kubeless documentation, available [here](./quick-start#installation).
Assuming that the Kubernetes cluster is up and running on top of ACS, its time to install kubeless-controller on master VM. To accomplish, please, follow the steps described on Kubeless documentation, available [here](/docs/quick-start#installation).

## 4. Installing "Kubeless Client CLI"

Kubeless-Controller is the agent in charge to manage the requests from Kubernetes cluster side. The same way, there's an agent in charge to manage the occurrences from the client side (for instance: register a new function to be executed, call an existing function, etc.). This way, you'll need to install de Kubeless CLI.

Currently there's two different ways to accomplish that: manually (generating binaries manually) or in a automatized way (using a pre-compiled package provided by Bitnami). Follow the [installation instructions](./quick-start#installation) in order to set it up as well.
Currently there's two different ways to accomplish that: manually (generating binaries manually) or in a automatized way (using a pre-compiled package provided by Bitnami). Follow the [installation instructions](/docs/quick-start#installation) in order to set it up as well.

## 5. Usage and initial tests

Please follow Kubeless oficial documentation, available [here](./quick-start#usage).
Please follow Kubeless oficial documentation, available [here](/docs/quick-start#usage).
8 changes: 4 additions & 4 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ NAME AGE
get-python 1d
```

### Details on [installing kubeless in a different namespace](./function-controller-configuration.md) can be found here.
> Details on [installing kubeless in a different namespace](/docs/function-controller-configuration) can be found here.
You are now ready to create functions.

Expand Down Expand Up @@ -66,7 +66,7 @@ Functions in Kubeless have the same format regardless of the language of the fun
- Receives a second object `context` with general information about the function.
- Returns a string/object that will be used as response for the caller.

You can find more details about the function interface [here](./runtimes#runtimes-interface)
You can find more details about the function interface [here](/docs/runtimes#runtimes-interface)

You create it with:

Expand Down Expand Up @@ -129,11 +129,11 @@ $ curl -L --data '{"Another": "Echo"}' \
{"Another": "Echo"}
```

Kubeless also supports [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) which means you can provide your custom URL to the function. Please refer to [this doc](./routing) for more details.
Kubeless also supports [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) which means you can provide your custom URL to the function. Please refer to [this doc](/docs/routing) for more details.

## PubSub function

We provide several [PubSub runtimes](https://hub.docker.com/r/kubeless/), which has suffix `event-consumer`, which help you to quickly deploy your function with PubSub mechanism. The PubSub function will expect to consume input messages from a predefined Kafka topic which means Kafka is required. In Kubeless [release page](https://github.com/kubeless/kubeless/releases), you can find the manifest to quickly deploy a collection of Kafka and Zookeeper statefulsets. If you have a Kafka cluster already running in the same Kubernetes environment, you can also deploy PubSub function with it. Check out [this tutorial](./use-existing-kafka.md) for more details how to do that.
We provide several [PubSub runtimes](https://hub.docker.com/r/kubeless/), which has suffix `event-consumer`, which help you to quickly deploy your function with PubSub mechanism. The PubSub function will expect to consume input messages from a predefined Kafka topic which means Kafka is required. In Kubeless [release page](https://github.com/kubeless/kubeless/releases), you can find the manifest to quickly deploy a collection of Kafka and Zookeeper statefulsets. If you have a Kafka cluster already running in the same Kubernetes environment, you can also deploy PubSub function with it. Check out [this tutorial](/docs/use-existing-kafka) for more details how to do that.

If you want to deploy the manifest we provide to deploy Kafka and Zookeper execute the following command:

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ zookeeper-zoo-0 Pending 2m
```

If you are running Kubernetes in GKE check the specific guide [here](./GKE-deployment.md) to create the required disks and PVs. In other case, check the provider documentation of how to create these required volumes. Note that `kafka` and `zookeeper` are only needed when working with Kafka events, you can still use Kubeless to trigger functions using HTTP requests.
If you are running Kubernetes in GKE check the specific guide [here](/docs/GKE-deployment) to create the required disks and PVs. In other case, check the provider documentation of how to create these required volumes. Note that `kafka` and `zookeeper` are only needed when working with Kafka events, you can still use Kubeless to trigger functions using HTTP requests.

0 comments on commit e07f0f7

Please sign in to comment.