adapterdev.md: Corrections and additions #244
Conversation
Corrected links, added "Versioning", added "Useful links and references", updated "Deploying"
docs/en/dev/adapterdev.md
Outdated
|
|
||
| 1. Installing within the ioBroker admin interface: Refer users to section *(5.) Install adapter from your own URL* of [ioBroker Admin documentation](https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/admin/adapter.md). | ||
|
|
||
| 2. Alternatively, ask users to install the adapter through the command line: |
There was a problem hiding this comment.
If we add that there then also the required "iobroker upload name" needs to be added because without it will not work!
Way 1 ist the preferred one !!
There was a problem hiding this comment.
We can leave in but should state very loud that #1 is the preferred way. Maybe also add how to install from a branch via that
There was a problem hiding this comment.
Added accordingly. Further additions can be added in additional documentation improvements, there are many more parts to improve and extend, but let's start with at least something :-)
| |-----------|-----------|-----------| | ||
| | 1 | 2 | 3 | | ||
|
|
||
| #### Explanation |
There was a problem hiding this comment.
maybe also tell something about 0.x and the specialities? Maybe also "when a developer should increase to 1.0"?
There was a problem hiding this comment.
I don't know that in detail, therefore I cannot provide this info at this time.
There was a problem hiding this comment.
basically it is:
For versions lower then 1.0 a minor update is breaking ... so for those release it changes in this regard ...
There was a problem hiding this comment.
Added accordingly. Please review. Not sure if this is really true for stable versions, but would be consistent with SemVer https://semver.org/#how-do-i-know-when-to-release-100
docs/en/dev/adapterdev.md
Outdated
| ``` | ||
| If everything is OK and you have got positive feedback from users you can publish adapter on npm. It would be good if before publishing you will create realease on github. | ||
|
|
||
| If everything is OK and you have got positive feedback from users, you can publish the adapter on npm. It would be good if before publishing you will create realease on github. |
There was a problem hiding this comment.
Not quite sure how I can now update the file in the pull request, I will try and hope not to mess it up :)
Section "Deploying": removed "npm install..." and corrected type
Mic-M
changed the title
|
Can anyone review this? I guess Apollon is pretty busy due to js-controller 3.x and various other projects. |
You can add another branch in your repository (preferably based on the patch-1 branch and work there. You can even do that in the webinterface of github. For that go to you repository, select "patch-1" as branch, then open the branch selection again and type a new name -> will create a new branch based on the current state of patch-1 and the edits in that branch won't go into this Pullrequest. |
|
Thank you very much!! ANd sorry for the delay |
Corrected links, added "Versioning", added "Useful links and references", updated "Deploying"