Image-sequencer: Add New Modules To The Docs

[harshkhandeparkar]

Please describe the problem (or idea)

Some of the new modules which were added recently are not added to the docs/modules.md file.

• [ ] [Dither](https://github.com/publiclab/image-sequencer/blob/main/src/modules/Dither/info.json)
• [ ] [DrawRectangle](https://github.com/publiclab/image-sequencer/blob/main/src/modules/DrawRectangle/info.json)
• [ ] [PaintBucket](https://github.com/publiclab/image-sequencer/blob/main/src/modules/PaintBucket/info.json)
• [ ] [WhiteBalance](https://github.com/publiclab/image-sequencer/blob/main/src/modules/WhiteBalance/info.json)
• [ ] [Tint](https://github.com/publiclab/image-sequencer/blob/main/src/modules/Tint/info.json)
• [ ] [Threshold](https://github.com/publiclab/image-sequencer/blob/main/src/modules/Threshold/info.json)
• [ ] [FlipImage](https://github.com/publiclab/image-sequencer/blob/main/src/modules/FlipImage/info.json)

Current modules.md

Files to look into

• info.json: All the modules listed above link to their info.json files. You will get information about the modules there. You have to change these files to add a new property docs-link which is a link to their docs in the modules.md file.
• modules.md: The modules.md file linked above should be changed and docs to all modules should be added there.

Optional

All the module info.json files have linked directly to the modules.md file but the link does not link to the part that concerns the module.
https://github.com/publiclab/image-sequencer/blob/c445070937a9eb069745ced983f210b2f16da40b/src/modules/Channel/info.json#L12

Optionally add a link to the part of the modules.md file which documents the module.
For e.g. the following link links to the docs for channel module

https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#channel-module

---

Thank you!

Your help makes Public Lab better! We deeply appreciate your helping refine and improve this site.

To learn how to write really great issues, which increases the chances they'll be resolved, see:

https://publiclab.org/wiki/developers#Contributing+for+non-coders

[harsh1599]

I would like to work on this..

[harshkhandeparkar]

You can go ahead and resolve this but if you can resolve some other issue
then consider leaving this one for a first time

On Sun 27 Jan, 2019, 1:02 PM Harsh Prabhu <[email protected] wrote:

I would like to work on this..

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/719#issuecomment-457895833,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AhKOn4oBDUroVQzH2pOJ_ymUiK4oBy3wks5vHVXzgaJpZM4aUkHM
.

[harshkhandeparkar]

@harsh1599 if you have already started work then you can go ahead and open a PR. Thanks! 😊

[harsh1599]

Okay I'll take up another one

[harshkhandeparkar]

😊

On Sun 27 Jan, 2019, 1:26 PM Harsh Prabhu <[email protected] wrote:

Okay I'll take up another one

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/719#issuecomment-457897310,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AhKOnwLayrUY7hEYzfOyxDUOEuJxF8C3ks5vHVusgaJpZM4aUkHM
.

[harshkhandeparkar]

@harsh1599 actually you can resolve this one as this is going to give you knowledge about the modules. So if you are interested then you can solve this one

[harsh1599]

Sure..I'll solve this

[harshkhandeparkar]

:+1:

On Sun 27 Jan, 2019, 3:02 PM Harsh Prabhu <[email protected] wrote:

Sure..I'll solve this

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/719#issuecomment-457902662,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AhKOn0Yc2DdO-ScA0QJDW9YeczKjqGBhks5vHXI3gaJpZM4aUkHM
.

[harsh1599]

I'm a bit confused. Everything is present in the info.json file right? Like I need to just specify the options and the what they all do right?@HarshKhandeparkar

[harshkhandeparkar]

@harsh1599 the docs file is added so that people can go through it easily instead of going through all the info files. Also, people who don't have knowledge about JSON can read it.

[harshkhandeparkar]

@harsh1599 the info files may not have all the information you might have to add some info of your own sometimes. Even examples can be added.

[lohitha02]

Hello, Can I work on this issue?

[harshkhandeparkar]

Go ahead!

[harshkhandeparkar]

Please note that I have added two new modules to the list above. Thanks!

[lohitha02]

So I have to add the links to all the six modules that you've mentioned above right?

[harshkhandeparkar]

Yes. You don't just have to add links. You also have to document the modules which is the main purpose of this issue.

[lohitha02]

@HarshKhandeparkar please review my pr I've linked all the modules that concerns the part of the module

[lohitha02]

@HarshKhandeparkar I've done it can you please review it and let me know if I have to make any changes.

[harshkhandeparkar]

@lohitha a new FlipImage was added recently can you also add that to the docs?

[lohitha02]

@HarshKhandeparkar what about replacecolor module?

[harshkhandeparkar]

You can document it

On Tue 5 Mar, 2019, 6:55 PM Lohitha, [e-mail] wrote:

@HarshKhandeparkar https://github.com/HarshKhandeparkar what about
replacecolor module?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/719#issuecomment-469678184,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AhKOn4Lu5MV67W1KFDzl8qdu-1-yVZVeks5vTnAugaJpZM4aUkHM
.