Skip to content

Commit 41edf4d

Browse files
authored
update docs md to relevant path (#2530)
1 parent 5228285 commit 41edf4d

File tree

14 files changed

+159
-159
lines changed

14 files changed

+159
-159
lines changed

docs/basics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ Tests are written in a synchronous way. This improves the readability and mainta
296296
While writing tests you should not think about promises, and instead should focus on the test scenario.
297297

298298
However, behind the scenes **all actions are wrapped in promises**, inside of the `I` object.
299-
[Global promise](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js) chain is initialized before each test and all `I.*` calls will be appended to it, as well as setup and teardown.
299+
[Global promise](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/recorder.js) chain is initialized before each test and all `I.*` calls will be appended to it, as well as setup and teardown.
300300

301301
> 📺 [Learn how CodeceptJS](https://www.youtube.com/watch?v=MDLLpHAwy_s) works with promises by watching video on YouTube
302302
@@ -402,7 +402,7 @@ You can have multiple configuration files for a the same project, in this case y
402402
npx codeceptjs run -c codecept.ci.conf.js
403403
```
404404

405-
Tuning configuration for helpers like WebDriver, Puppeteer can be hard, as it requires good understanding of how these technologies work. Use the [`@codeceptjs/configure`](https://github.com/codecept-js/configure) package with common configuration recipes.
405+
Tuning configuration for helpers like WebDriver, Puppeteer can be hard, as it requires good understanding of how these technologies work. Use the [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with common configuration recipes.
406406

407407
For instance, you can set the window size or toggle headless mode, no matter of which helpers are actually used.
408408

@@ -419,7 +419,7 @@ exports.config = {
419419
}
420420
```
421421

422-
> ▶ See more [configuration recipes](https://github.com/codecept-js/configure)
422+
> ▶ See more [configuration recipes](https://github.com/codeceptjs/configure)
423423
424424
## Debug
425425

@@ -616,7 +616,7 @@ AfterSuite((I) => {
616616
});
617617
```
618618

619-
[Here are some ideas](https://github.com/codecept-js/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks.
619+
[Here are some ideas](https://github.com/codeceptjs/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks.
620620

621621
## Within
622622

docs/books.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ editLink: false
77
---
88

99
# Books & Posts
10-
> Add your own books or posts to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts)
10+
> Add your own books or posts to our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Books-&-Posts)
1111
### [Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)
1212

1313
A book by **Paul Vincent Beigang**
@@ -34,4 +34,4 @@ A list of good educational posts about CodeceptJS
3434
* [Customizing CodeceptJS Skeleton](https://medium.com/@successivetech/codeceptjs-skeleton-9ba86d3b45ec)
3535
* [Running End to End tests as Google Cloud Functions](https://hackernoon.com/running-end-to-end-tests-as-google-cloud-functions-f5e34ffc3984)
3636
* [End-To-End Testing With CodeceptJS](https://www.monterail.com/blog/end-to-end-testing-with-codeceptjs) by Piotr Michalski
37-
* [Getting started with CodeceptJS and Selenium WebDriver](https://medium.com/@garrettvorce/getting-started-with-selenium-and-codeceptjs-c0698e8df677)
37+
* [Getting started with CodeceptJS and Selenium WebDriver](https://medium.com/@garrettvorce/getting-started-with-selenium-and-codeceptjs-c0698e8df677)

docs/changelog.md

Lines changed: 123 additions & 123 deletions
Large diffs are not rendered by default.

docs/community-helpers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ editLink: false
55
---
66

77
# Community Helpers
8-
> Share your helpers at our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Community-Helpers)
8+
> Share your helpers at our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Community-Helpers)
99
1010
Here is the list of helpers created by our community.
1111
Please **add your own** by editing this page.
@@ -47,4 +47,4 @@ Please **add your own** by editing this page.
4747

4848
## Other
4949

50-
* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.
50+
* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ codeceptjs run --config=./path/to/my/config.js
101101

102102
> 📺 [Watch this material](https://www.youtube.com/watch?v=onBnfo_rJa4&t=4s) on YouTube
103103
104-
[`@codeceptjs/configure` package](https://github.com/codecept-js/configure) contains shared recipes for common configuration patterns. This allows to set meta-configuration, independent from a current helper enabled.
104+
[`@codeceptjs/configure` package](https://github.com/codeceptjs/configure) contains shared recipes for common configuration patterns. This allows to set meta-configuration, independent from a current helper enabled.
105105

106106
Install it and enable to easily switch to headless/window mode, change window size, etc.
107107

docs/custom-helpers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ helpers: {
3636
}
3737
```
3838

39-
Helpers are ES6 classes inherited from [corresponding abstract class](https://github.com/codecept-js/CodeceptJS/blob/master/lib/helper.js).
39+
Helpers are ES6 classes inherited from [corresponding abstract class](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/helper.js).
4040
Generated Helper will be added to `codecept.conf.js` config file. It should look like this:
4141

4242
```js

docs/data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ By doing this we can make requests within the current browser session without a
314314
> Sharing browser session with ApiDataFactory or GraphQLDataFactory can be especially useful when you test Single Page Applications
315315
316316
Since CodeceptJS 2.3.3 there is a simple way to enable shared session for browser and data helpers.
317-
Install [`@codeceptjs/configure`](https://github.com/codecept-js/configure) package:
317+
Install [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package:
318318
319319
```
320320
npm i @codeceptjs/configure --save

docs/email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ I.seeInEmailSubject('Awesome Proposal!');
155155
I.seeInEmailBody('To unsubscribe click here');
156156
```
157157

158-
> More methods are listed in [helper's API reference](https://github.com/codecept-js/mailslurp-helper/blob/master/README.md#api)
158+
> More methods are listed in [helper's API reference](https://github.com/codeceptjs/mailslurp-helper/blob/master/README.md#api)
159159
160160
## Listing All Emails
161161

docs/examples.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ editLink: false
77
---
88

99
# Examples
10-
> Add your own examples to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Examples)
11-
## [TodoMVC Examples](https://github.com/codecept-js/examples)
10+
> Add your own examples to our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Examples)
11+
## [TodoMVC Examples](https://github.com/codeceptjs/examples)
1212

13-
![](https://github.com/codecept-js/examples/raw/master/todo.png)
13+
![](https://github.com/codeceptjs/examples/raw/master/todo.png)
1414

1515
Playground repository where you can run tests in different helpers on a basic single-page website.
1616

@@ -23,7 +23,7 @@ Tests repository demonstrate usage of
2323
* PageObjects
2424
* Cucumber syntax
2525

26-
## [Basic Examples](https://github.com/Codeception/CodeceptJS/tree/master/examples)
26+
## [Basic Examples](https://github.com/codeceptjs/CodeceptJS/tree/master/examples)
2727

2828
CodeceptJS repo contains basic tests (both failing and passing) just to show how it works.
2929
Our team uses it to test new features and run simple scenarios.
@@ -145,4 +145,4 @@ This is a ready to use example that shows how to integrate CodeceptJS with Puppe
145145
* puppeteer helper example
146146
* test steps, pages, fragments
147147
* examples for sequential and parallel execution
148-
* generation of allure test results
148+
* generation of allure test results

docs/hooks.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ module.exports = {
240240

241241
Plugins allow to use CodeceptJS internal API to extend functionality. Use internal event dispatcher, container, output, promise recorder, to create your own reporters, test listeners, etc.
242242

243-
CodeceptJS includes [built-in plugins](/plugins/) which extend basic functionality and can be turned on and off on purpose. Taking them as [examples](https://github.com/codecept-js/CodeceptJS/tree/master/lib/plugin) you can develop your custom plugins.
243+
CodeceptJS includes [built-in plugins](/plugins/) which extend basic functionality and can be turned on and off on purpose. Taking them as [examples](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/plugin) you can develop your custom plugins.
244244

245245
A plugin is a basic JS module returning a function. Plugins can have individual configs which are passed into this function:
246246

@@ -255,7 +255,7 @@ module.exports = function(config) {
255255
}
256256
```
257257

258-
Plugin can register event listeners or hook into promise chain with recorder. See [API reference](https://github.com/codecept-js/CodeceptJS/tree/master/lib/helper).
258+
Plugin can register event listeners or hook into promise chain with recorder. See [API reference](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/helper).
259259

260260
To enable your custom plugin in config add it to `plugins` section. Specify path to node module using `require`.
261261

@@ -332,21 +332,21 @@ module.exports = function(options) {
332332
CodeceptJS provides an API which can be loaded via `require('codeceptjs')` when CodeceptJS is installed locally.
333333
These internal objects are available:
334334

335-
* [`codecept`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/codecept.js): test runner class
336-
* [`config`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/config.js): current codecept config
337-
* [`event`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/event.js): event listener
338-
* [`recorder`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js): global promise chain
339-
* [`output`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/output.js): internal printer
340-
* [`container`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/container.js): dependency injection container for tests, includes current helpers and support objects
341-
* [`helper`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/helper.js): basic helper class
342-
* [`actor`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/actor.js): basic actor (I) class
335+
* [`codecept`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/codecept.js): test runner class
336+
* [`config`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/config.js): current codecept config
337+
* [`event`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/event.js): event listener
338+
* [`recorder`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/recorder.js): global promise chain
339+
* [`output`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/output.js): internal printer
340+
* [`container`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/container.js): dependency injection container for tests, includes current helpers and support objects
341+
* [`helper`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/helper.js): basic helper class
342+
* [`actor`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/actor.js): basic actor (I) class
343343

344-
[API reference](https://github.com/codecept-js/CodeceptJS/tree/master/docs/api) is available on GitHub.
344+
[API reference](https://github.com/codeceptjs/CodeceptJS/tree/master/docs/api) is available on GitHub.
345345
Also please check the source code of corresponding modules.
346346

347347
### Event Listeners
348348

349-
CodeceptJS provides a module with [event dispatcher and set of predefined events](https://github.com/codecept-js/CodeceptJS/blob/master/lib/event.js).
349+
CodeceptJS provides a module with [event dispatcher and set of predefined events](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/event.js).
350350

351351
It can be required from codeceptjs package if it is installed locally.
352352

@@ -387,7 +387,7 @@ Available events:
387387
* *sync* - means that event is fired in the moment of action happens.
388388
* *async* - means that event is fired when an actions is scheduled. Use `recorder` to schedule your actions.
389389

390-
For further reference look for [currently available listeners](https://github.com/codecept-js/CodeceptJS/tree/master/lib/listener) using event system.
390+
For further reference look for [currently available listeners](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/listener) using event system.
391391

392392
#### Test Object
393393

@@ -419,7 +419,7 @@ Step events provide step objects with following fields:
419419

420420
### Recorder
421421

422-
To inject asynchronous functions in a test or before/after a test you can subscribe to corresponding event and register a function inside a recorder object. [Recorder](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js) represents a global promises chain.
422+
To inject asynchronous functions in a test or before/after a test you can subscribe to corresponding event and register a function inside a recorder object. [Recorder](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/recorder.js) represents a global promises chain.
423423

424424
Provide a function description as a first parameter, function should return a promise:
425425

0 commit comments

Comments
 (0)