Skip to content

Commit

Permalink
Add links to versioned docs from main README 🔗
Browse files Browse the repository at this point in the history
For a long time now we've wanted to have versioned docs - the docs you
get when you look at the repo only work for HEAD, which can be different
from our releases.

For example, TWICE today I've seen users try to run our examples with
the new `$()` syntax with `v0.5.2` deployed :( @vdemeester pointed out
we should get versioned docs asap so until we have some cool docs
generated (with versions!) at tekton.dev, I think this might be an okay
stopgap?

This commit adds a table which links to the markdown files associated
with each version. I'm also going to update the releases in GitHub
themselves to contain a link to these docs and examples.
  • Loading branch information
bobcatfish authored and tekton-robot committed Aug 14, 2019
1 parent 1699fd8 commit c105b68
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,20 @@ Tekton Pipelines are **Typed**:

- [Installing Tekton Pipelines](docs/install.md)
- Jump in with [the tutorial!](docs/tutorial.md)
- [Read about it](/docs/README.md)
- Look at [some examples](/examples)

### Read the docs

| Version | Docs | Examples |
| ------- | ---- | -------- |
| [HEAD](DEVELOPMENT.md#install-pipeline) | [Docs @ HEAD](/docs/README.md) | [Examples @ HEAD](/examples) |
| [v0.5.2](https://github.com/tektoncd/pipeline/releases/tag/v0.5.2) | [Docs @ v0.5.2](https://github.com/tektoncd/pipeline/tree/v0.5.2/docs#tekton-pipelines) | [Examples @ v0.5.2](https://github.com/tektoncd/pipeline/tree/v0.5.2/examples#examples) |
| [v0.5.1](https://github.com/tektoncd/pipeline/releases/tag/v0.5.1) | [Docs @ v0.5.1](https://github.com/tektoncd/pipeline/tree/v0.5.1/docs#tekton-pipelines) | [Examples @ v0.5.1](https://github.com/tektoncd/pipeline/tree/v0.5.1/examples#examples) |
| [v0.5.0](https://github.com/tektoncd/pipeline/releases/tag/v0.5.0) | [Docs @ v0.5.0](https://github.com/tektoncd/pipeline/tree/v0.5.0/docs#tekton-pipelines) | [Examples @ v0.5.0](https://github.com/tektoncd/pipeline/tree/v0.5.0/examples#examples) |
| [v0.4.0](https://github.com/tektoncd/pipeline/releases/tag/v0.4.0) | [Docs @ v0.4.0](https://github.com/tektoncd/pipeline/tree/v0.4.0/docs#tekton-pipelines) | [Examples @ v0.4.0](https://github.com/tektoncd/pipeline/tree/v0.4.0/examples#examples) |
| [v0.3.1](https://github.com/tektoncd/pipeline/releases/tag/v0.3.1) | [Docs @ v0.3.1](https://github.com/tektoncd/pipeline/tree/v0.3.1/docs#tekton-pipelines) | [Examples @ v0.3.1](https://github.com/tektoncd/pipeline/tree/v0.3.1/examples#examples) |
| [v0.3.0](https://github.com/tektoncd/pipeline/releases/tag/v0.3.0) | [Docs @ v0.3.0](https://github.com/tektoncd/pipeline/tree/v0.3.0/docs#tekton-pipelines) | [Examples @ v0.3.0](https://github.com/tektoncd/pipeline/tree/v0.3.0/examples#examples) |
| [v0.2.0](https://github.com/tektoncd/pipeline/releases/tag/v0.2.0) | [Docs @ v0.2.0](https://github.com/tektoncd/pipeline/tree/v0.2.0/docs#tekton-pipelines) | [Examples @ v0.2.0](https://github.com/tektoncd/pipeline/tree/v0.2.0/examples#examples) |
| [v0.1.0](https://github.com/tektoncd/pipeline/releases/tag/v0.1.0) | [Docs @ v0.1.0](https://github.com/tektoncd/pipeline/tree/v0.1.0/docs#tekton-pipelines) | [Examples @ v0.1.0](https://github.com/tektoncd/pipeline/tree/v0.1.0/examples#examples) |

_See [our API compatibility policy](api_compatibility_policy.md) for info on the
stability level of the API._
Expand Down
9 changes: 9 additions & 0 deletions tekton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ GCP project](https://github.com/tektoncd/plumbing#prow). To release you will wan
we often just [create the release](#creating-a-new-release) and we skip the bit where we publish
the ci images (which rarely change anyway). Hashtag lazy manual anti-pattern.

3. Create the new tag and release in GitHub
([see one of way of doing that here](https://github.com/tektoncd/pipeline/issues/530#issuecomment-477409459)).
_TODO(#530): Automate as much of this as possible with Tekton._

4. Add an entry to [the README](../README.md) at `HEAD` for docs and examples for the new release
([README.md#read-the-docs](README.md#read-the-docs)).

5. Update the new release in GitHub with the same links to the docs and examples, see
[v0.1.0](https://github.com/tektoncd/pipeline/releases/tag/v0.1.0) for example.

### Run the Pipeline

Expand Down

0 comments on commit c105b68

Please sign in to comment.