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

docs: added customize import strategy doc #2253

Merged
merged 2 commits into from
Sep 26, 2022
Merged

Conversation

shahednasser
Copy link
Member

  • Added Customize Import Strategy documentation
  • Rearranged links under "How-to Guides" in the sidebar to show nested categories at the top.

Closes DOCS-232 and DOCS-253

@shahednasser shahednasser requested a review from a team as a code owner September 23, 2022 13:33
@changeset-bot
Copy link

changeset-bot bot commented Sep 23, 2022

⚠️ No Changeset found

Latest commit: 6c6dfcd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Collaborator

@srindom srindom left a comment

Choose a reason for hiding this comment

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

LGTM - w. comments

Comment on lines 44 to 61
import { AbstractBatchJobStrategy, BatchJobService } from '@medusajs/medusa'
import { EntityManager } from 'typeorm'

class ImportStrategy extends AbstractBatchJobStrategy {
protected batchJobService_: BatchJobService
protected manager_: EntityManager
protected transactionManager_: EntityManager

processJob(batchJobId: string): Promise<void> {
throw new Error('Method not implemented.')
}
buildTemplate(): Promise<string> {
throw new Error('Method not implemented.')
}
}

export default ImportStrategy
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

think we should make it clear that there are more methods to implement than just these two

So, for example, to overwrite the product import strategy set the `batchType` property in your strategy to `product-import`:

```tsx
class ImportStrategy extends AbstractBatchJobStrategy {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
class ImportStrategy extends AbstractBatchJobStrategy {
class MyImportStrategy extends AbstractBatchJobStrategy {


So, for example, to overwrite the product import strategy set the `batchType` property in your strategy to `product-import`:

```tsx
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: technically this isn't tsx but pure typescript

Suggested change
```tsx
```typescript

Copy link
Member Author

Choose a reason for hiding this comment

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

That's true, it's exported from Notion in that format. I added a vale rule to spot it in the future

@shahednasser shahednasser merged commit 8b125ba into master Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants