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

Create docs for extensions - Closes #1742 #1798

Merged
merged 9 commits into from Mar 22, 2019

Conversation

Projects
None yet
2 participants
@michaeltomasik
Copy link
Member

commented Feb 27, 2019

What issue have I solved?

#1742

How have I implemented/fixed it?

How has this been tested?

Review checklist

@michaeltomasik michaeltomasik self-assigned this Feb 27, 2019

@michaeltomasik michaeltomasik force-pushed the 1742-create-docs-for-extensions branch from 00c0dec to 2fe49ab Feb 27, 2019

michaeltomasik added some commits Feb 28, 2019

@michaeltomasik michaeltomasik requested review from Efefefef and slaweet Mar 4, 2019

michaeltomasik added some commits Mar 4, 2019

@slaweet slaweet changed the base branch from 1.13.0 to 1.14.0 Mar 11, 2019

@@ -0,0 +1,53 @@
# Lisk Hub Extension Guideline
``` ⚠️ Extension System is only avaliable in development mode ⚠️```

This comment has been minimized.

Copy link
@slaweet

slaweet Mar 11, 2019

Member

What does it mean "development mode"? IMO the explanation should be more explicit about npm run dev vs. npm run start vs. npm run build vs. npm run dist vs. npm run pack

#### Props
Data from our store is accessible via `this.props.data` and actions to modify our store are in `this.props.actions`. Keep in mind that We are not sharing all data and actions. In case You want to access sth that is unavailable let us know by creating a feature proposal/ticket in our repo.
#### How to Share Your extension with others?

This comment has been minimized.

Copy link
@slaweet

slaweet Mar 11, 2019

Member

I would put here a note to distinguish between how it works now vs. how it should work in the future.

![Alt text](./assets/add_extension_link.png?raw=true "Github raw link")
5. Open `/extensions` page
6. Paste Your url to input field and press Add Extension.

This comment has been minimized.

Copy link
@slaweet

slaweet Mar 11, 2019

Member

Here I would expect some description of what will happen - the url is stored locally and when is the extension executed.

![Alt text](./assets/create_extension_3.png?raw=true "Github File with extension")
#### Props
Data from our store is accessible via `this.props.data` and actions to modify our store are in `this.props.actions`. Keep in mind that We are not sharing all data and actions. In case You want to access sth that is unavailable let us know by creating a feature proposal/ticket in our repo.

This comment has been minimized.

Copy link
@slaweet

slaweet Mar 11, 2019

Member

Some hint on what props are available would be nice

michaeltomasik added some commits Mar 22, 2019

@slaweet slaweet added the ready label Mar 22, 2019

@michaeltomasik michaeltomasik merged commit 92d1ea1 into 1.14.0 Mar 22, 2019

4 checks passed

Jenkins e2e tests e2e tests passed
Details
Jenkins test deployment Commit was deployed to test
Details
continuous-integration/jenkins/pr-merge This commit looks good
Details
security/snyk - package.json (LiskHQ) No new issues
Details

@michaeltomasik michaeltomasik deleted the 1742-create-docs-for-extensions branch Mar 22, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.