Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to Typescript Quickstart #3582

Merged
merged 13 commits into from Jan 30, 2024

Conversation

kdhamric
Copy link
Collaborator

Made several changes:

A large number of our quick starts reference the docs in the readme rather than duplicating the steps to run - I changed the Readme to follow this convention and pointed users to it.

Moved the steps to run the quick start from the Readme into the docs.

Removed material explaining how the tracetest agent connection, collector configuration, and docker compose network are configured so the quick start focuses solely on the use of the NPM package. As I read the quick start initially all the other information distracted me from the goal of showing how to use the NPM library.

A large number of our quick starts reference the docs in the readme rather than duplicating the steps to run - I changed the Readme to follow this convention and pointed users to it.

Placed the steps to run the quick start in the docs.

Removed material explaining how the tracetest agent connection, collector configuration, and docker compose network are configured so the quick start focuses solely on the use of the NPM package.
kdhamric and others added 2 commits January 29, 2024 19:58
Co-authored-by: Julianne Fermi <julianne@kubeshop.io>
Co-authored-by: Julianne Fermi <julianne@kubeshop.io>
Copy link
Member

@jfermi jfermi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there places where screenshots would be helpful?

Copy link
Contributor

@adnanrahic adnanrahic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some copywriting edits.

docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
docs/docs/tools-and-integrations/typescript.mdx Outdated Show resolved Hide resolved
kdhamric and others added 10 commits January 30, 2024 08:01
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
Co-authored-by: Adnan Rahić <adnan@kubeshop.io>
@kdhamric kdhamric merged commit 5121c7c into main Jan 30, 2024
37 checks passed
@kdhamric kdhamric deleted the typescript-quickstart-and-example-changes branch January 30, 2024 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants