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

Additional instructions for setting up helix-importer for fixes #201

Merged
merged 1 commit into from
Jun 19, 2023
Merged
Changes from all commits
Commits
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
16 changes: 15 additions & 1 deletion importer-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,6 +642,20 @@ Every new project has its own collection of new use cases which might be totally
```

And reload the importer ui browser window.

ℹ️ If you want to make and/or propose changes in the `helix-importer` package (a dependency for `helix-importer-ui`, following additional steps would be needed:
1. check-out https://github.com/adobe/helix-importer
1. execute `npm i` in the repository root
1. execute `npm link`
1. navigate to `helix-importer-ui` checkout folder from your project root (typically `$PROJECT_ROOT/tools/importer/helix-importer-ui`
1. execute `npm i`
* not required if you've already been working on importer via `hlx import`)
1. execute `npm link @adobe/helix-importer`
1. update the `build:dev` goal in `package.json`, and remove `npm i` execution from the goal
* this is required, otherwise the symlink created by `npm link @adobe/helix-importer` will be reset
1. execute `npm run build:dev` and reload the importer ui browser window.
* this step is required for all subsequent (local) updates made to `helix-importer` dependency
* to restore, revert changes made to `package.json` and repeat this step

## Advanced

Expand Down Expand Up @@ -700,4 +714,4 @@ export default {
};
```

Just add the extra styles you need to perform your transformation.
Just add the extra styles you need to perform your transformation.