docs: Update to helm usage by default #413
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Prem Saraswat <prmsrswt@gmail.com>
paulfantom
reviewed
Jun 7, 2022
README.md
Outdated
| ## Installing the CLI tool | ||
| ## Prerequisites | ||
|
|
||
| Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager. To do install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/). |
There was a problem hiding this comment.
Suggested change
| Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager. To do install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/). | |
| Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager. | |
| To install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/). |
README.md
Outdated
| We also have additional documentation about individual configuration settings in our | ||
| [Helm chart docs](chart/README.md#configuring-helm-chart). | ||
|
|
||
| # 🛠Alternative deployment methods |
There was a problem hiding this comment.
Suggested change
| # 🛠Alternative deployment methods | |
| # Alternative deployment methods |
WDYT about dropping emojis from the doc?
There was a problem hiding this comment.
Dropped them for now. I don't have any strong opinions about it.
README.md
Outdated
| We also have additional documentation about individual configuration settings in our | ||
| [Helm chart docs](chart/README.md#configuring-helm-chart). | ||
|
|
||
| # 🛠Alternative deployment methods |
There was a problem hiding this comment.
Suggested change
| # 🛠Alternative deployment methods | |
| # Alternative deployment methods |
WDYT about dropping emojis from the doc?
README.md
Outdated
|
|
||
| *NOTE*: At this point, the CLI tool is just a thin wrapper around the helm chart, and hence it's set to be removed in future releases. | ||
|
|
||
| ### Installing the CLI tool |
There was a problem hiding this comment.
Could we drop it and instead point to cli/README.md doc?
README.md
Outdated
|
|
||
| *NOTE*: At this point, the CLI tool is just a thin wrapper around the helm chart, and hence it's set to be removed in future releases. | ||
|
|
||
| ### Installing the CLI tool |
There was a problem hiding this comment.
Could we drop all sub-sections of cli installation and instead point to cli/README.md doc?
README.md
Outdated
|
|
||
| # 🛠Alternative deployment methods | ||
|
|
||
| ## [DEPRECATED] Using the `tobs` CLI tool |
There was a problem hiding this comment.
Suggested change
| ## [DEPRECATED] Using the `tobs` CLI tool | |
| ## Using the `tobs` CLI tool |
It's not yet deprecated. It will be after next release (0.11.0).
README.md
Outdated
|
|
||
| # 🛠Alternative deployment methods | ||
|
|
||
| ## [DEPRECATED] Using the `tobs` CLI tool |
There was a problem hiding this comment.
Suggested change
| ## [DEPRECATED] Using the `tobs` CLI tool | |
| ## Using the `tobs` CLI tool |
It's not yet deprecated. It will be after next release (0.11.0).
README.md
Outdated
| @@ -45,7 +80,7 @@ Alternatively, you can download the CLI directly via [our releases page](https:/ | |||
|
|
|||
| Getting started with the CLI tool is a two-step process: First you install the CLI tool locally, then you use the CLI tool to install the tobs stack into your Kubernetes cluster. | |||
|
|
|||
| ## Using the tobs CLI tool to deploy the stack into your Kubernetes cluster | |||
| ### Using the tobs CLI tool to deploy the stack into your Kubernetes cluster | |||
Signed-off-by: Prem Saraswat <prmsrswt@gmail.com>
paulfantom
approved these changes
Jun 8, 2022
README.md
Outdated
| ## Installing the CLI tool | ||
| ## Prerequisites | ||
|
|
||
| Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager. To do install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/). |
There was a problem hiding this comment.
Suggested change
| Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager. To do install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/). | |
| Using tobs to install full observability stack with openTelemetry support currently requires installation of cert-manager. | |
| To install it please follow [cert-manager documentation](https://cert-manager.io/docs/installation/). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Prem Saraswat prmsrswt@gmail.com
Description
Fixes #393
Type of change
What type of changes does your code introduce to tobs? Put an
xin the box that apply.CHANGE(fix or feature that would cause existing functionality to not work as expected)FEATURE(non-breaking change which adds functionality)BUGFIX(non-breaking change which fixes an issue)ENHANCEMENT(non-breaking change which improves existing functionality)NONE(if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)