Skip to content

Commit

Permalink
docs: update some docs all around (#170)
Browse files Browse the repository at this point in the history
  • Loading branch information
zivl committed Mar 11, 2023
1 parent 295088f commit abefba7
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 33 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand All @@ -20,23 +20,23 @@ 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 [email protected]:wix/sentry-testkit.git`
1. `git clone [email protected]:zivl/sentry-testkit.git`
2. `npm install`

## Writing Code
* Make sure to write functions with minimal side effects.
* 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.
* Your PRs will be merged after passing all relevant conditions (build, testing... etc.).

## 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;
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
<a href="https://npmjs.org/package/sentry-testkit">
<img src="https://img.shields.io/npm/dm/sentry-testkit.svg" alt="npm downloads">
</a>
<a href="https://github.com/wix/sentry-testkit/actions">
<img src="https://github.com/wix/sentry-testkit/workflows/Test/badge.svg" alt="Test">
<a href="https://github.com/zivl/sentry-testkit/actions">
<img src="https://github.com/zivl/sentry-testkit/workflows/Test/badge.svg" alt="Test">
</a>
</p>
<p align="center">
Expand All @@ -19,7 +19,7 @@
</p>
</p>
<p align="center">
<a href="https://wix.github.io/sentry-testkit/">
<a href="https://zivl.github.io/sentry-testkit/">
<img alt="sentry-teskit" src="./docs/logo/Sentry_github.svg" height="132">
</a>
</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<div style="text-align: center;">
<img alt="sentry-teskit-npm" src="https://img.shields.io/npm/v/sentry-testkit.svg">
<img alt="sentry-teskit-downloads" src="https://img.shields.io/npm/dm/sentry-testkit.svg">
<img alt="sentry-teskit-tests" src="https://github.com/wix/sentry-testkit/workflows/Test/badge.svg">
<img alt="sentry-teskit-tests" src="https://github.com/zivl/sentry-testkit/workflows/Test/badge.svg">
<img alt="sentry-teskit-v6" src="https://img.shields.io/badge/Compatible%20with%20Sentry-v6-blue">
<img alt="sentry-teskit-v7" src="https://img.shields.io/badge/Compatible%20with%20Sentry-v7-blue">
</div>
Expand All @@ -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)
6 changes: 3 additions & 3 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
```
npm install sentry-testkit --save-dev
```
**yarn:**
**yarn:**
```
yarn add sentry-testkit --dev
```
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
<meta property="og:type" content="website" />
<meta property="og:title" content="Sentry-Testkit" />
<meta property="og:description" content="Testing Sentry Reports Became Easy" />
<meta property="og:image" content="https://wix.github.io/sentry-testkit/logo/sentry-testkit-logo.png" />
<meta property="og:image" content="https://zivl.github.io/sentry-testkit/logo/sentry-testkit-logo.png" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="350" />
<meta property="og:url" content="https://wix.github.io/sentry-testkit/" />
<meta property="og:url" content="https://zivl.github.io/sentry-testkit/" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="robots" content="index, api" />
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" />
Expand All @@ -25,12 +25,12 @@
<script>
window.$docsify = {
name: 'Sentry Testkit',
repo: 'https://github.com/wix/sentry-testkit',
repo: 'https://github.com/zivl/sentry-testkit',
loadSidebar: true,
autoHeader: true,
notFoundPage: true,
plugins: [
EditOnGithubPlugin.create('https://github.com/wix/sentry-testkit/blob/master/docs/')
EditOnGithubPlugin.create('https://github.com/zivl/sentry-testkit/blob/master/docs/')
],
search: 'auto',
logo: './logo/sentry-testkit-logo.svg',
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"sentry-plugin",
"sentry-client"
],
"author": "Ziv Levy (zivl@wix.com)",
"author": "Ziv Levy (levi.ziv@gmail.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/zivl/sentry-testkit/issues"
Expand Down
2 changes: 1 addition & 1 deletion website/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,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.
Expand Down
8 changes: 4 additions & 4 deletions website/docs/migration/version-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ test('something', function () {
});
```
But we're having issue with that:
1. We're getting errors `Sentry is not defined` and `Maximum call stack size exceeded` (looks like circular dep): https://github.com/wix/sentry-testkit/runs/2477315004
3. re-declaring block-scope variables (looks like es imports helps with this, but then we got into first problem): https://github.com/wix/sentry-testkit/pull/78/checks?check_run_id=2826583066
1. We're getting errors `Sentry is not defined` and `Maximum call stack size exceeded` (looks like circular dep): https://github.com/zivl/sentry-testkit/runs/2477315004
3. re-declaring block-scope variables (looks like es imports helps with this, but then we got into first problem): https://github.com/zivl/sentry-testkit/pull/78/checks?check_run_id=2826583066

You may refer to the source code of [`jestMock.ts`](https://github.com/wix/sentry-testkit/blob/master/src/jestMock.ts) and we'll be happy for your help and suggestions.
You may refer to the source code of [`jestMock.ts`](https://github.com/zivl/sentry-testkit/blob/master/src/jestMock.ts) and we'll be happy for your help and suggestions.

For further details and discussion, please follow [issue #136](https://github.com/wix/sentry-testkit/issues/136)
For further details and discussion, please follow [issue #136](https://github.com/zivl/sentry-testkit/issues/136)

**[UPDATE]**: Thanks to [@liamjones](https://github.com/liamjones)'s contribution, this issue is no longer exists and you maybe upgrade your `sentry-testkit` versions safely!
12 changes: 6 additions & 6 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula')
const config = {
title: 'Sentry-Testkit',
tagline: 'Testing your reports made easy',
url: 'https://wix.github.io/',
url: 'https://zivl.github.io/',
baseUrl: '/sentry-testkit/',
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'wix', // Usually your GitHub org/user name.
organizationName: 'zivl', // Usually your GitHub org/user name.
projectName: 'sentry-testkit', // Usually your repo name.
trailingSlash: false,

Expand All @@ -38,7 +38,7 @@ const config = {
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/wix/sentry-testkit/blob/master/website/docs',
'https://github.com/zivl/sentry-testkit/blob/master/website/docs',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
Expand Down Expand Up @@ -87,7 +87,7 @@ const config = {
label: 'Help',
},
{
href: 'https://github.com/wix/sentry-testkit',
href: 'https://github.com/zivl/sentry-testkit',
position: 'right',
className: 'header-github-link',
'aria-label': 'GitHub repository',
Expand Down Expand Up @@ -123,7 +123,7 @@ const config = {
items: [
{
label: 'Github Issues',
href: 'https://github.com/wix/sentry-testkit/issues',
href: 'https://github.com/zivl/sentry-testkit/issues',
},
{
label: 'Stack Overflow',
Expand All @@ -141,7 +141,7 @@ const config = {
items: [
{
label: 'GitHub repo',
href: 'https://github.com/wix/sentry-testkit',
href: 'https://github.com/zivl/sentry-testkit',
},
{
label: 'Help',
Expand Down
6 changes: 3 additions & 3 deletions website/src/pages/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Get help with Sentry Testkit

# Need help?

sentry-testkit is worked on by Wix Engineering developers lead by Ziv Levy, as well as many other contributors who help us fix bugs, suggest more features and etc.
`sentry-testkit` is worked was created by Ziv Levy and maintained by Ziv, as well as many other contributors who help fix bugs, suggest more features and etc.

## More ways to talk to our community

Expand All @@ -19,9 +19,9 @@ Find what you're looking for in our detailed documentation and guides.
### Join the community
Ask questions and find answers from other sentry-testkit users like you.
- Many members of the community use Stack Overflow. Read through the [existing questions](https://stackoverflow.com/questions/tagged/sentry-testkit) tagged with **sentry-testkit** or [ask your own](https://stackoverflow.com/questions/ask)!
- Look at our [Github Issues](https://github.com/wix/sentry-testkit/issues) pages.
- Look at our [Github Issues](https://github.com/zivl/sentry-testkit/issues) pages.

### Stay up to date
Find out what's new with sentry-testkit.
- Follow [Ziv Levy](https://twitter.com/_zivlevy) on Twitter.
- Look at the [changelog](https://github.com/wix/sentry-testkit/blob/master/CHANGELOG.md).
- Look at the [changelog](https://github.com/zivl/sentry-testkit/blob/master/CHANGELOG.md).
2 changes: 1 addition & 1 deletion website/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export default function Home(): JSX.Element {
/>
<img
alt="sentry-teskit-tests"
src="https://github.com/wix/sentry-testkit/workflows/Test/badge.svg"
src="https://github.com/zivl/sentry-testkit/workflows/Test/badge.svg"
/>
<img
alt="sentry-teskit-v6"
Expand Down

0 comments on commit abefba7

Please sign in to comment.