Reword the Snowtype CLI intro, delete the disorse reference. #993
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
✅ Deploy Preview for snowplow-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
stanch
reviewed
Aug 28, 2024
| @@ -8,14 +8,10 @@ sidebar_label: "Code Generation" | |||
| This documentation only applies to [Snowplow BDP](https://snowplow.io/snowplow-bdp/). See the [feature comparison](/docs/feature-comparison/index.md) page for more information about the different Snowplow offerings. | |||
| ::: | |||
|
|
|||
| Snowplow has created tooling around assisting development efforts on instrumenting, verifying and maintaining tracking code that works with Snowplow tracking SDKs. This is the `Snowtype CLI`. | |||
| The `Snowtype CLI` is a tool that assists with instrumenting, verifying and maintaining tracking code that works with Snowplow tracking SDKs. | |||
There was a problem hiding this comment.
Why not just this?
Suggested change
| The `Snowtype CLI` is a tool that assists with instrumenting, verifying and maintaining tracking code that works with Snowplow tracking SDKs. | |
| **Snowtype** is a tool that assists with instrumenting, verifying and maintaining tracking code. Snowtype works with Snowplow tracking SDKs. |
stanch
reviewed
Aug 28, 2024
|
|
||
| ```mdx-code-block | ||
| import DocCardList from '@theme/DocCardList'; | ||
|
|
||
| <DocCardList /> | ||
| ``` | ||
|
|
||
| ## Getting help or giving feedback |
There was a problem hiding this comment.
@igneel64 John makes a good point that Discourse might not be the best platform, seeing as how this is a BDP-specific doc. But do we have a different channel for feedback?
stanch
reviewed
Aug 28, 2024
| @@ -8,14 +8,10 @@ sidebar_label: "Code Generation" | |||
| This documentation only applies to [Snowplow BDP](https://snowplow.io/snowplow-bdp/). See the [feature comparison](/docs/feature-comparison/index.md) page for more information about the different Snowplow offerings. | |||
There was a problem hiding this comment.
Since you are editing this file, I’ve noticed that this banner is not correctly implemented. Could you fix it? The :::info needs to be removed entirely, and instead the following needs to be added before ---:
sidebar_custom_props:
offerings:
- bdp
cc @igneel64 — please see https://github.com/snowplow/documentation?tab=readme-ov-file#offerings.
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.
No description provided.