Skip to content

Commit

Permalink
convert to Hugo rel link
Browse files Browse the repository at this point in the history
  • Loading branch information
RichieEscarez committed Feb 21, 2019
1 parent febbc01 commit f1bbc8e
Show file tree
Hide file tree
Showing 44 changed files with 123 additions and 126 deletions.
2 changes: 1 addition & 1 deletion community/samples/README.md
Expand Up @@ -2,4 +2,4 @@

| Sample Name | Knative Component | Description | Language(s) |
| --------------| ----------------- | -------------------------- | ----------------- |
| Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Rust](./serving/helloworld-rust/README.md), [Shell](./serving/helloworld-shell/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) |
| Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](serving/helloworld-clojure/), [Dart](serving/helloworld-dart/), [Elixir](serving/helloworld-elixir/), [Haskell](serving/helloworld-haskell/), [Rust](serving/helloworld-rust/), [Shell](serving/helloworld-shell/), [Swift](serving/helloworld-swift/), [Vertx](serving/helloworld-vertx/) |
2 changes: 1 addition & 1 deletion contributing/CONTRIBUTING.md
Expand Up @@ -172,7 +172,7 @@ reviewers to the PR, set labels, run tests automatically, and so forth.

See [Reviewing and Merging Pull Requests](REVIEWING/) for the PR review and
merge process used for Knative and for more information about
[Prow](./REVIEWING/#prow).
[Prow](../REVIEWING/#prow).

## Issues

Expand Down
10 changes: 5 additions & 5 deletions contributing/DOCS-CONTRIBUTING.md
Expand Up @@ -15,7 +15,7 @@ propose changes to this document in a pull request.

### Code of conduct

Knative follows the [Knative Code of Conduct](./CODE-OF-CONDUCT/). By
Knative follows the [Knative Code of Conduct](../CODE-OF-CONDUCT/). By
participating, you are expected to uphold this code. Please report unacceptable
behavior to knative-code-of-conduct@googlegroups.com.

Expand All @@ -39,7 +39,7 @@ see a problem with the documentation, submit an issue using the following steps:
When you create a bug report, include as many details as possible and
include suggested fixes to the issue. If you know which Knative component
your bug is related to, you can assign the appropriate
[Working Group Lead](./WORKING-GROUPS/).
[Working Group Lead](../WORKING-GROUPS/).
- **Feature request**: For upcoming changes to the documentation or requests
for more information on a particular subject.

Expand All @@ -51,7 +51,7 @@ documentation issues should go in the `docs` repository.

### Working group

The [Knative Documentation Working Group](./WORKING-GROUPS/#documentation)
The [Knative Documentation Working Group](../WORKING-GROUPS/#documentation)
meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to
accommodate contributors in both the EMEA and APAC timezones.
[Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com)
Expand All @@ -66,9 +66,9 @@ There are a couple different ways to jump in to the Knative doc set:

- Look at issues in the Docs repo labled
[Good First Issue](https://github.com/knative/docs/labels/kind%2Fgood-first-issue).
- Run through the [install guide](../install/README.md) for the platform of your
- Run through the [install guide](../../install/docs/README.md) for the platform of your
choice, as well as the
[Getting Started with Knative App Deployment](../install/getting-started-knative-app/)
[Getting Started with Knative App Deployment](../../install/docs/getting-started-knative-app/)
guide, and keep a
[friction log](https://devrel.net/developer-experience/an-introduction-to-friction-logging)
of the experience. What was hard for you? Then open a PR with a few
Expand Down
2 changes: 1 addition & 1 deletion contributing/README.md
Expand Up @@ -56,7 +56,7 @@ tools, platforms, languages, and products. By submitting a tutorial you can
share your experience and help others who are solving similar problems.

Community tutorials are stored in Markdown files on
[GitHub](../community/samples/) where they can be reviewed and edited by the
[GitHub](../../community/samples/) where they can be reviewed and edited by the
community.

Please submit a Pull Request to the community sample directory under the Knative
Expand Down
4 changes: 2 additions & 2 deletions contributing/SLACK-GUIDELINES.md
Expand Up @@ -22,7 +22,7 @@ https://slack.knative.dev.

## Code of Conduct

The Knative [Code of Conduct](./CODE-OF-CONDUCT/) applies throughout the
The Knative [Code of Conduct](../CODE-OF-CONDUCT/) applies throughout the
project, and includes all communication mediums.

## Admins
Expand Down Expand Up @@ -56,7 +56,7 @@ privately.
Please reach out to the #slack-admins group with your request to create a new
channel.

Channels are dedicated to [Working Groups](./WORKING-GROUPS/), sub-projects,
Channels are dedicated to [Working Groups](../WORKING-GROUPS/), sub-projects,
community topics, and related programs/projects.

Channels are not:
Expand Down
62 changes: 31 additions & 31 deletions docs/README.md
Expand Up @@ -9,11 +9,11 @@ patterns and codify the best practices that are shared by successful,
real-world, Kubernetes-based frameworks and applications. Knative components
focus on solving mundane but difficult tasks such as:

- [Deploying a container](./install/getting-started-knative-app)
- [Orchestrating source-to-URL workflows on Kubernetes](./serving/samples/source-to-url-go/)
- [Routing and managing traffic with blue/green deployment](./serving/samples/blue-green-deployment)
- [Scaling automatically and sizing workloads based on demand](./serving/samples/autoscale-go)
- [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source)
- [Deploying a container](install/getting-started-knative-app)
- [Orchestrating source-to-URL workflows on Kubernetes](serving/samples/source-to-url-go/)
- [Routing and managing traffic with blue/green deployment](serving/samples/blue-green-deployment)
- [Scaling automatically and sizing workloads based on demand](serving/samples/autoscale-go)
- [Binding running services to eventing ecosystems](eventing/samples/kubernetes-event-source)

Developers on Knative can use familiar idioms, languages, and frameworks to
deploy functions, applications, or containers workloads.
Expand All @@ -33,7 +33,7 @@ The following Knative components are available:

Knative is designed for different personas:

![Diagram that displays different Audiences for Knative](./images/knative-audience.svg)
![Diagram that displays different Audiences for Knative](images/knative-audience.svg)

### Developers

Expand All @@ -60,8 +60,8 @@ separation between pluggable components, the Knative project establishes an
efficient contributor workflow.

Knative is a diverse, open, and inclusive community. To get involved, see
[CONTRIBUTING.md](./contributing/CONTRIBUTING) and join the
[Knative community](./community/).
[CONTRIBUTING.md](../../contributing/CONTRIBUTING/) and join the
[Knative community](../../community/).

Your own path to becoming a Knative contributor can
[begin anywhere](https://github.com/knative/serving/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fgood-first-issue).
Expand All @@ -74,41 +74,41 @@ Follow the links below to learn more about Knative.

### Getting started

- [Installing Knative](./install/)
- [Getting started with app deployment](./install/getting-started-knative-app)
- [Getting started with serving](./serving)
- [Getting started with builds](./build)
- [Getting started with eventing](./eventing)
- [Installing Knative](install/)
- [Getting started with app deployment](install/getting-started-knative-app)
- [Getting started with serving](serving)
- [Getting started with builds](build)
- [Getting started with eventing](eventing)

### Configuration and networking

- [Configuring outbound network access](./serving/outbound-network-access)
- [Using a custom domain](./serving/using-a-custom-domain)
- [Assigning a static IP address for Knative on Google Kubernetes Engine](./serving/gke-assigning-static-ip-address)
- [Configuring HTTPS with a custom certificate](./serving/using-an-ssl-cert)
- [Configuring outbound network access](serving/outbound-network-access)
- [Using a custom domain](serving/using-a-custom-domain)
- [Assigning a static IP address for Knative on Google Kubernetes Engine](serving/gke-assigning-static-ip-address)
- [Configuring HTTPS with a custom certificate](serving/using-an-ssl-cert)

### Samples and demos

- [Autoscaling](./serving/samples/autoscale-go/)
- [Source-to-URL deployment](./serving/samples/source-to-url-go/)
- [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source)
- [Telemetry](./serving/samples/telemetry-go/)
- [REST API sample](./serving/samples/rest-api-go/)
- [All samples for serving](./serving/samples/)
- [All samples for eventing](./eventing/samples/)
- [Autoscaling](serving/samples/autoscale-go/)
- [Source-to-URL deployment](serving/samples/source-to-url-go/)
- [Binding running services to eventing ecosystems](eventing/samples/kubernetes-event-source)
- [Telemetry](serving/samples/telemetry-go/)
- [REST API sample](serving/samples/rest-api-go/)
- [All samples for serving](serving/samples/)
- [All samples for eventing](eventing/samples/)

### Logging and metrics

- [Installing logging, metrics and traces](./serving/installing-logging-metrics-traces)
- [Accessing logs](./serving/accessing-logs)
- [Accessing metrics](./serving/accessing-metrics)
- [Accessing traces](./serving/accessing-traces)
- [Setting up a logging plugin](./serving/setting-up-a-logging-plugin)
- [Installing logging, metrics and traces](serving/installing-logging-metrics-traces)
- [Accessing logs](serving/accessing-logs)
- [Accessing metrics](serving/accessing-metrics)
- [Accessing traces](serving/accessing-traces)
- [Setting up a logging plugin](serving/setting-up-a-logging-plugin)

### Debugging

- [Debugging application issues](./serving/debugging-application-issues)
- [Debugging performance issues](./serving/debugging-performance-issues)
- [Debugging application issues](serving/debugging-application-issues)
- [Debugging performance issues](serving/debugging-performance-issues)

---

Expand Down
8 changes: 4 additions & 4 deletions docs/build/README.md
Expand Up @@ -12,9 +12,9 @@ action, you can define a Knative `Build` through a single configuration file.

Also consider using a Knative `Build` to build the source code of your apps into
container images, which you can then run on
[Knative `serving`](../serving/).
[Knative `serving`](../../serving/).
More information about this use case is demonstrated in
[this sample](../serving/samples/source-to-url-go).
[this sample](../../serving/samples/source-to-url-go).

## Key features of Knative Builds

Expand Down Expand Up @@ -49,7 +49,7 @@ Before you can run a Knative Build, you must install the Knative Build component
in your Kubernetes cluster:

- For details about installing a new instance of Knative in your Kubernetes
cluster, see [Installing Knative](../install/).
cluster, see [Installing Knative](../../install/).

- If you have a component of Knative installed and running, you can
[add and install the Knative Build component](installing-build-component/).
Expand Down Expand Up @@ -103,7 +103,7 @@ builds.

#### Complex samples

- [Use Knative to build apps from source code and then run those containers](../serving/samples/source-to-url-go).
- [Use Knative to build apps from source code and then run those containers](../../serving/samples/source-to-url-go).

## Related info

Expand Down
1 change: 0 additions & 1 deletion docs/build/builder-contract.md
Expand Up @@ -70,7 +70,6 @@ Builders should expect a Build to implement the following conventions:
- Credentials attached to the Build's service account may be exposed as Git or
Docker credentials as outlined [here](../auth/).


---

Except as otherwise noted, the content of this page is licensed under the
Expand Down
2 changes: 0 additions & 2 deletions docs/build/builds.md
Expand Up @@ -107,7 +107,6 @@ of the `steps` fields, or container images that you define:
For details about how to ensure that you implement each step to align with the
"builder contract", see the [`Builder`](../builder-contract/) reference topic.


#### Template

The `template` field is a required if no `steps` are defined. Specifies a
Expand Down Expand Up @@ -150,7 +149,6 @@ of the `Build` resource object.
For examples and more information about specifying service accounts, see the
[`ServiceAccount`](../auth/) reference topic.


#### Volumes

Optional. Specifies one or more
Expand Down
6 changes: 3 additions & 3 deletions docs/eventing/README.md
Expand Up @@ -61,13 +61,13 @@ event sources. Sources manage registration and delivery of events from external
systems using Kubernetes
[Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
Learn more about Eventing development in the
[Eventing work group](../../contributing/WORKING-GROUPS.md#events).
[Eventing work group](../../contributing/WORKING-GROUPS/#events).

## Installation

Knative Eventing currently requires Knative Serving and Istio version 1.0 or
later installed.
[Follow the instructions to install on the platform of your choice](../install/).
[Follow the instructions to install on the platform of your choice](../../install/).

Many of the sources require making outbound connections to create the event
subscription, and if you have any functions that make use of any external (to
Expand Down Expand Up @@ -247,7 +247,7 @@ The CronJobSource fires events based on given

## Getting Started

- [Setup Knative Serving](../install/)
- [Setup Knative Serving](../../install/)
- [Install Eventing components](#installation)
- [Run samples](samples/)

Expand Down
8 changes: 4 additions & 4 deletions docs/eventing/samples/gcp-pubsub-source/README.md
Expand Up @@ -15,7 +15,7 @@ source is most useful as a bridge from other GCP services, such as
project id, and also set your project ID as default using
`gcloud config set project $PROJECT_ID`.

1. Setup [Knative Serving](../../../install)
1. Setup [Knative Serving](../../../../install)

1. Setup
[Knative Eventing](https://github.com/knative/docs/tree/master/eventing). In
Expand Down Expand Up @@ -70,7 +70,7 @@ source is most useful as a bridge from other GCP services, such as
`controller-manager` StatefulSet which manages your Eventing sources.

`google-cloud-key` and `key.json` are pre-configured values in
[`gcp-pubsub-source.yaml`](./gcp-pubsub-source.yaml).
[`gcp-pubsub-source.yaml`](../gcp-pubsub-source.yaml).

## Deployment

Expand All @@ -97,15 +97,15 @@ source is most useful as a bridge from other GCP services, such as

1. Create a GCP PubSub Topic. If you change its name (`testing`), you also need
to update the `topic` in the
[`gcp-pubsub-source.yaml`](./gcp-pubsub-source.yaml) file:
[`gcp-pubsub-source.yaml`](../gcp-pubsub-source.yaml) file:

```shell
gcloud pubsub topics create testing
```

1. Replace the
[`MY_GCP_PROJECT` placeholder](https://cloud.google.com/resource-manager/docs/creating-managing-projects)
in [`gcp-pubsub-source.yaml`](./gcp-pubsub-source.yaml) and apply it.
in [`gcp-pubsub-source.yaml`](../gcp-pubsub-source.yaml) and apply it.

If you're in the samples directory, you can replace `MY_GCP_PROJECT` and
apply in one command:
Expand Down
2 changes: 1 addition & 1 deletion docs/eventing/samples/github-source/README.md
Expand Up @@ -10,7 +10,7 @@ You will need:

1. An internet-accessible Kubernetes cluster with Knative Serving
installed. Follow the [installation
instructions](../../../install/)
instructions](../../../../install/)
if you need to create one.
1. Ensure Knative Serving is [configured with a domain
name](../../../serving/using-a-custom-domain.md)
Expand Down
17 changes: 8 additions & 9 deletions docs/install/Knative-custom-install.md
Expand Up @@ -15,7 +15,7 @@ to run multiple installation commands.
## Before you begin

- If you are new to Knative, you should instead
[follow one of the platform-specific installation guides](./) to help
[follow one of the platform-specific installation guides](../) to help
you get up and running quickly.

- The steps in this guide use `bash` for the MacOS or Linux environment; for
Expand Down Expand Up @@ -70,7 +70,7 @@ service mesh. If you install any of the following options, you must install

- [Knative Eventing](https://github.com/knative/eventing)
- [Knative Eventing Sources](https://github.com/knative/eventing-sources)
- [Observability plugins](../serving/installing-logging-metrics-traces/)
- [Observability plugins](../../serving/installing-logging-metrics-traces/)

#### Istio installation options

Expand Down Expand Up @@ -210,7 +210,7 @@ files from the Knative repositories:
| [`message-dumper.yaml`][5.3] | Installs an Event logging service for debugging. | Serving component, Eventing component |

_\*_ See
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces/)
[Installing logging, metrics, and traces](../../serving/installing-logging-metrics-traces/)
for details about installing the various supported observability plug-ins.

† These are the recommended standard install files suitable for most use cases.
Expand Down Expand Up @@ -330,7 +330,6 @@ commands below.
kubectl get pods --namespace knative-monitoring
```


See
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md)
for details about setting up the various supported observability plug-ins.
Expand All @@ -343,14 +342,14 @@ events in your Knative cluster.
Depending on the Knative components you installed, you can use the following
guides to help you get started with Knative:

- [Getting Started with Knative App Deployment](./getting-started-knative-app/)
- [Getting Started with Knative App Deployment](../getting-started-knative-app/)

- [Knative Serving sample apps](../serving/samples/)
- [Knative Serving sample apps](../../serving/samples/)

- [Creating a simple Knative Build](../build/creating-builds/)
- [Creating a simple Knative Build](../../build/creating-builds/)

- [Knative Build templates](https://github.com/knative/build-templates)

- [Knative Eventing overview](../eventing/)
- [Knative Eventing overview](../../eventing/)

- [Knative Eventing code samples](../eventing/samples)
- [Knative Eventing code samples](../../eventing/samples)
2 changes: 1 addition & 1 deletion docs/install/Knative-with-AKS.md
Expand Up @@ -200,7 +200,7 @@ To deploy your first app with Knative, follow the step-by-step
guide.

To get started with Knative Eventing, pick one of the
[Eventing Samples](../eventing/samples/) to walk through.
[Eventing Samples](../../eventing/samples/) to walk through.

To get started with Knative Build, read the [Build README](../build/README.md),
then choose a sample to walk through.
Expand Down
2 changes: 1 addition & 1 deletion docs/install/Knative-with-Docker-for-Mac.md
Expand Up @@ -103,7 +103,7 @@ Knative, check out the
guide.

If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/) repo.
head to the [sample apps](../../serving/samples/) repo.

> Note: You can replace the {IP_ADDRESS} placeholder used in the samples with
> `localhost` as mentioned above.
Expand Down
2 changes: 1 addition & 1 deletion docs/install/Knative-with-Minikube.md
Expand Up @@ -130,7 +130,7 @@ Knative, check out the
guide.

If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/) repo.
head to the [sample apps](../../serving/samples/) repo.

> Note: When looking up the IP address to use for accessing your app, you need
> to look up the NodePort for the `istio-ingressgateway` well as the IP address
Expand Down
2 changes: 1 addition & 1 deletion docs/install/Knative-with-Minishift.md
Expand Up @@ -278,7 +278,7 @@ curl -H "Host: helloworld-go.myproject.example.com" http://$IP_ADDRESS
```

If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/) repository.
head to the [sample apps](../../serving/samples/) repository.

## Cleaning up

Expand Down

0 comments on commit f1bbc8e

Please sign in to comment.