Skip to content

Commit c105b68

Browse files
bobcatfishtekton-robot
authored andcommitted
Add links to versioned docs from main README 🔗
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.
1 parent 1699fd8 commit c105b68

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

‎README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,20 @@ Tekton Pipelines are **Typed**:
2828

2929
- [Installing Tekton Pipelines](docs/install.md)
3030
- Jump in with [the tutorial!](docs/tutorial.md)
31-
- [Read about it](/docs/README.md)
32-
- Look at [some examples](/examples)
31+
32+
### Read the docs
33+
34+
| Version | Docs | Examples |
35+
| ------- | ---- | -------- |
36+
| [HEAD](DEVELOPMENT.md#install-pipeline) | [Docs @ HEAD](/docs/README.md) | [Examples @ HEAD](/examples) |
37+
| [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) |
38+
| [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) |
39+
| [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) |
40+
| [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) |
41+
| [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) |
42+
| [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) |
43+
| [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) |
44+
| [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) |
3345

3446
_See [our API compatibility policy](api_compatibility_policy.md) for info on the
3547
stability level of the API._

‎tekton/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,15 @@ GCP project](https://github.com/tektoncd/plumbing#prow). To release you will wan
9090
we often just [create the release](#creating-a-new-release) and we skip the bit where we publish
9191
the ci images (which rarely change anyway). Hashtag lazy manual anti-pattern.
9292

93+
3. Create the new tag and release in GitHub
94+
([see one of way of doing that here](https://github.com/tektoncd/pipeline/issues/530#issuecomment-477409459)).
95+
_TODO(#530): Automate as much of this as possible with Tekton._
96+
97+
4. Add an entry to [the README](../README.md) at `HEAD` for docs and examples for the new release
98+
([README.md#read-the-docs](README.md#read-the-docs)).
99+
100+
5. Update the new release in GitHub with the same links to the docs and examples, see
101+
[v0.1.0](https://github.com/tektoncd/pipeline/releases/tag/v0.1.0) for example.
93102

94103
### Run the Pipeline
95104

0 commit comments

Comments
 (0)