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

Migrate documentation to docusaurus v2 #1924

Merged
merged 45 commits into from
Jul 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
497b8bf
Migrate to docusaurus v2
EugeniyBurmistrov May 26, 2021
44d0bbd
Fix migration problems
EugeniyBurmistrov May 26, 2021
7d08029
Fix uncompatible markup
EugeniyBurmistrov May 27, 2021
14ed5d5
Add landing
EugeniyBurmistrov Jun 1, 2021
0a75122
Split reference
EugeniyBurmistrov Jun 1, 2021
5e15fa0
Landing main content
EugeniyBurmistrov Jun 2, 2021
c4287bc
Add footer
EugeniyBurmistrov Jun 2, 2021
198bcf8
Fix incompatible layout
EugeniyBurmistrov Jun 3, 2021
7022a06
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jun 18, 2021
be61d3a
Minor fixes
EugeniyBurmistrov Jun 25, 2021
df8a059
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jun 25, 2021
7d902d0
Update to docusaurus beta.2
EugeniyBurmistrov Jun 28, 2021
f998dfc
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jun 28, 2021
1b2e13a
Add a serve script
EugeniyBurmistrov Jun 28, 2021
511b6dd
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jun 28, 2021
fdf6e22
Folder structure
EugeniyBurmistrov Jun 28, 2021
ff00c2d
Split the client API
EugeniyBurmistrov Jun 29, 2021
1a8754f
Fix broken links
EugeniyBurmistrov Jun 29, 2021
a6d57fa
Fix broken links
EugeniyBurmistrov Jun 30, 2021
e82519e
Merge remote-tracking branch 'origin/dev' into docs/migrate-to-docusa…
EugeniyBurmistrov Jun 30, 2021
3bbac0d
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jun 30, 2021
42a00a1
Remove broken embedmd sample
EugeniyBurmistrov Jun 30, 2021
1da993b
Remove "last updated"
EugeniyBurmistrov Jun 30, 2021
5a7fcc0
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jun 30, 2021
039755f
Add section emphasis, fix paddings
EugeniyBurmistrov Jul 1, 2021
58d34db
Fix paddings
EugeniyBurmistrov Jul 1, 2021
5bfc8d9
Add section emphasis, fix paddings
EugeniyBurmistrov Jul 1, 2021
6e0fb35
Fix paddings
EugeniyBurmistrov Jul 1, 2021
33fc2c8
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jul 1, 2021
e2c0566
Remove docusaurus v1
EugeniyBurmistrov Jul 1, 2021
a0425f2
Remove docusaurus v1
EugeniyBurmistrov Jul 1, 2021
cc96940
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jul 1, 2021
563d7ab
Fix gitignore
EugeniyBurmistrov Jul 1, 2021
cef2f8a
Merge branch 'docs/migrate-to-docusaurusv2' into docs/split-api-refer…
EugeniyBurmistrov Jul 1, 2021
c7c357c
Fix config
EugeniyBurmistrov Jul 1, 2021
56a13f0
Fix config
EugeniyBurmistrov Jul 1, 2021
eb1d081
Broken link
EugeniyBurmistrov Jul 1, 2021
34da68e
Fix static asssets
EugeniyBurmistrov Jul 1, 2021
2a2d2fe
Fix static asssets
EugeniyBurmistrov Jul 1, 2021
9d2e478
Merge branch 'docs/split-api-reference' into docs/migrate-to-docusaur…
EugeniyBurmistrov Jul 1, 2021
a00b1f0
Merge remote-tracking branch 'origin/dev' into docs/migrate-to-docusa…
EugeniyBurmistrov Jul 1, 2021
e82eb4c
Merge branch 'dev' into docs/migrate-to-docusaurusv2
EugeniyBurmistrov Jul 2, 2021
5d7c52a
Remove redundant file
EugeniyBurmistrov Jul 2, 2021
4445565
Fix normalize_paths
MrCheater Jul 2, 2021
23aaa03
Merge branch 'dev' into docs/migrate-to-docusaurusv2
EugeniyBurmistrov Jul 2, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ dist
lib
es
types
/website/.docusaurus
/website/node_modules
/website/build
/website/i18n
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: index
title: reSolve Documentation
description: Full stack CQRS, DDD, Event Sourcing framework for Node.js
slug: /
---

[Introduction](introduction.md)
Expand Down Expand Up @@ -76,16 +77,15 @@ description: Full stack CQRS, DDD, Event Sourcing framework for Node.js
- [Debug a ReSolve Application](debugging.md#debug-a-resolve-application)

- [Testing](testing.md)

- [Testing Tools](testing.md#testing-tools)
- [Testing Aggregates](testing.md#testing-aggregates)
- [Testing Read Models](testing.md#testing-read-models)
- [Testing Sagas](testing.md#testing-sagas)

[FAQ](faq.md)

[API Reference](api-reference.md)
- [Application Configuration](application-configuration.md)

[Application Configuration](application-configuration.md)
[FAQ](faq.md)

[Troubleshooting](troubleshooting.md)

Expand Down
16 changes: 8 additions & 8 deletions docs/advanced-techniques.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: advanced-techniques
title: Advanced Techniques
description: This document describes advanced techniques that can help уou extend your reSolve application's functionality.
description: "This document describes advanced techniques that can help уou extend your reSolve application's functionality."
---

## Splitting Code Into Chunks
Expand Down Expand Up @@ -405,7 +405,7 @@ Incremental import allows you to import into an event store only those events th

### Basic Incremental Import

To import events incrementally, pass an array of events to an event store adapter's [incrementalImport](api-reference.md#incrementalimport) method.
To import events incrementally, pass an array of events to an event store adapter's [incrementalImport](api/event-store-adapter.md#incrementalimport) method.

The code sample below implements an API endpoint that incrementally imports events into the application's event store.

Expand Down Expand Up @@ -436,12 +436,12 @@ export default handler

The following methods give you additional control over the incremental import process:

| Method | Description |
| ----------------------------------------------------------------------- | --------------------------------------------------- |
| [beginIncrementalImport](api-reference.md#beginincrementalimport) | Starts to accumulate events for incremental import. |
| [pushIncrementalImport](api-reference.md#pushincrementalimport) | Accumulates events for incremental import. |
| [commitIncrementalImport](api-reference.md#commitincrementalimport) | Commits the accumulated events to the event store. |
| [rollbackIncrementalImport](api-reference.md#rollbackincrementaiImport) | Drops the accumulated events. |
| Method | Description |
| --------------------------------------------------------------------------------- | --------------------------------------------------- |
| [beginIncrementalImport](api/event-store-adapter.md#beginincrementalimport) | Starts to accumulate events for incremental import. |
| [pushIncrementalImport](api/event-store-adapter.md#pushincrementalimport) | Accumulates events for incremental import. |
| [commitIncrementalImport](api/event-store-adapter.md#commitincrementalimport) | Commits the accumulated events to the event store. |
| [rollbackIncrementalImport](api/event-store-adapter.md#rollbackincrementaiImport) | Drops the accumulated events. |

The code sample below demonstrates how to use advanced incremental import in a try-catch block to roll back in case of errors.

Expand Down
2 changes: 1 addition & 1 deletion docs/api-handlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The configuration object specifies the following options:
| Handler | The path to the file that contains the handler's definition. |
| Method | The HTTP method to handle. |

Refer to the [Application Configuration](application-configuration) topic for more information.
Refer to the [Application Configuration](application-configuration.md) topic for more information.

## Implementation Examples

Expand Down
Loading