From abefba7c3968b69bb6589abd5338631719da1924 Mon Sep 17 00:00:00 2001 From: Ziv Levy Date: Sat, 11 Mar 2023 20:00:18 +0200 Subject: [PATCH] docs: update some docs all around (#170) --- CONTRIBUTING.md | 8 ++++---- LICENSE | 2 +- README.md | 6 +++--- docs/README.md | 4 ++-- docs/getting-started/README.md | 6 +++--- docs/index.html | 8 ++++---- package.json | 2 +- website/docs/getting-started.md | 2 +- website/docs/migration/version-5.md | 8 ++++---- website/docusaurus.config.js | 12 ++++++------ website/src/pages/help.md | 6 +++--- website/src/pages/index.tsx | 2 +- 12 files changed, 33 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1bd7421..4cb98dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ We use [conventionalcommits](https://conventionalcommits.org) to format our commit messages. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, -we use the git commit messages to generate the [Sentry Testkit release notes](https://github.com/wix/sentry-testkit/releases). +we use the git commit messages to generate the [Sentry Testkit release notes](https://github.com/zivl/sentry-testkit/releases). Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: @@ -20,7 +20,7 @@ format that includes a **type**, a **scope** and a **subject**: More info about message format and list of types could be found [here](https://conventionalcommits.org) ## Local Setup -1. `git clone git@github.com:wix/sentry-testkit.git` +1. `git clone git@github.com:zivl/sentry-testkit.git` 2. `npm install` ## Writing Code @@ -28,7 +28,7 @@ More info about message format and list of types could be found [here](https://c * We always prefer `const` on `let`. * Make up clear and readable variable names and function names. * Update documentation in case you add/modify/remove any kind of behaviour. -* Test any code that you push in. +* Test any code that you push in. ## Git Stuff * Make sure you're rebased with `master` branch. Especially if you're working on a long feature. @@ -36,7 +36,7 @@ More info about message format and list of types could be found [here](https://c ## Release -We use [standard-version](https://github.com/conventional-changelog/standard-version) to prepare the [CHANGELOG.md](./CHANGELOG.md) file and git tags (to have correct [release notes](https://github.com/wix/sentry-testkit/releases)). +We use [standard-version](https://github.com/conventional-changelog/standard-version) to prepare the [CHANGELOG.md](./CHANGELOG.md) file and git tags (to have correct [release notes](https://github.com/zivl/sentry-testkit/releases)). Release process: * merge all related PRs to master; diff --git a/LICENSE b/LICENSE index 8bdcf7a..3fa0c2b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 Wix.com +Copyright (c) 2017 Ziv Levy (levi.ziv@gmail.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 3afbc1c..8a14816 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ npm downloads - - Test + + Test

@@ -19,7 +19,7 @@

- + sentry-teskit

diff --git a/docs/README.md b/docs/README.md index 43d0367..a5f4ee0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@
sentry-teskit-npm sentry-teskit-downloads - sentry-teskit-tests + sentry-teskit-tests sentry-teskit-v6 sentry-teskit-v7
@@ -18,4 +18,4 @@ However, when building tests for your application, you want to assert that the r *Sentry Testkit* enables Sentry to work natively in your application, and by overriding the default Sentry transport mechanism, the report is not really sent but rather logged locally into memory. In this way, the logged reports can be fetched later for your own usage, verification, or any other use you may have in your local developing/testing environment. > [!NOTE] -> This documentation is for the latest version of `sentry-testkit`. For v2, please visit [here](https://github.com/wix/sentry-testkit/tree/v2.x/docs/api) +> This documentation is for the latest version of `sentry-testkit`. For v2, please visit [here](https://github.com/zivl/sentry-testkit/tree/v2.x/docs/api) diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index df5267c..38ecb0c 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -4,7 +4,7 @@ ``` npm install sentry-testkit --save-dev ``` -**yarn:** +**yarn:** ``` yarn add sentry-testkit --dev ``` @@ -38,7 +38,7 @@ test('collect performance events', function () { ``` ### Working with []() [Jest](https://jestjs.io/en/) -We've added a new option to integrate `sentry-testkit` with `jest`'s mocking mechanism. Detailed implementation can be seen [here](https://github.com/wix/sentry-testkit/blob/master/src/jestMock.js). +We've added a new option to integrate `sentry-testkit` with `jest`'s mocking mechanism. Detailed implementation can be seen [here](https://github.com/zivl/sentry-testkit/blob/master/src/jestMock.js). At the moment it is available only to `@sentry/browser` package but we will expand to more packages as we should figure out how to do it right for all Sentry's client packages. @@ -96,7 +96,7 @@ beforeAll(function(){ }) ``` -You may see more usage examples in the [testing section](https://github.com/wix/sentry-testkit/tree/master/test) of `sentry-testkit` repository as well +You may see more usage examples in the [testing section](https://github.com/zivl/sentry-testkit/tree/master/test) of `sentry-testkit` repository as well > [!TIP] > Pay attention that Sentry reports the events asynchronously. diff --git a/docs/index.html b/docs/index.html index dc6ab1a..ebbcdf0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -11,10 +11,10 @@ - + - + @@ -25,12 +25,12 @@