Load Image Docs Link Should Not Be Displayed (as it doesn't exist)

[harshkhandeparkar]

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open-source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new and looking through our general help wanted issues. Thanks!

What is to be done?

The first step in every sequence of ImageSequencer is the load-image step where the input image is loaded. This is just a sequencer method and not an actual module. It has no dedicated documentation.

All the other modules of ImageSequencer have their own docs here

Even though load-image has no docs, there is a link in the UI for load-image which leads to nothing.

Files to refer to:

1. image-sequencer/examples/lib/defaultHtmlStepUi.js

   Lines 48 to 50 in d1b9b8b

   	<div class="cal collapse in"><p>' +
   	'<a href="https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#' + step.name + '-module">' + (step.description || '') + '</a>' +
   	'</p></div>\

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

• 🙋 Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

• 📝 Modify the file defaultHtmlStepUi.js

• 💾 Commit your changes

• 🔀 Start a Pull Request. There are two ways how you can start a pull request:

1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

2. You can also edit files directly in your browser and open a pull request from there.

• 🏁 Done Ask in comments for a review :)

Please keep us updated

💬⏰ - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need it if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

Is someone else already working on this?

🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

🤔❓ Questions?

Leave a comment below!

[pcube99]

I want to work on this issue.
can you elaborate, what I am supposed to do in this ?

[harshkhandeparkar]

You have to make it so that only the first step has no link.

[harshkhandeparkar]

All the other steps' description should be clickable.

[pcube99]

so I just need to put an If statement or an ternary operator and check that step.name is load-image or not.

If it is load-image then remove the link otherwise redirect it.

[harshkhandeparkar]

Yeah. Great! You can ask for help here. We are always ready to help.

[pcube99]

@harshkhandeparkar please check the PR.

[harshkhandeparkar]

This one is open :)

[ashirbad29]

I want to work on this issue, how should i proceed?

[harshkhandeparkar]

Just follow the steps mentioned in the issue body @ashirbad29 :) If there is any doubt, please ask.

[harshkhandeparkar]

In short, as you can see in that code, it tries to generate a link to the docs but the link doesn't always exist. Instead of dynamically generating, you can use step['docs-link'] because all the links have been manually written under that parameter.
Just check if step['docs-link'] exists, if it does then only show the link.

[ashirbad29]

since its a small issue i change the code in the browser, should I need to test the code first by npm-run-test

[ashirbad29]

@harshkhandeparkar please review my PR :)

[harshkhandeparkar]

since its a small issue i change the code in the browser, should I need to test the code first by npm-run-test

Not really, I don't think that part even has a test.

[ashirbad29]

@harshkhandeparkar I worked on your suggestion and made changes, please review it

[GuptaTanisha]

@harshkhandeparkar Can I work on this?

[harshkhandeparkar]

It was actually fixed by the other PR but the PR has a conflict. Maybe you can revive that PR?

[SharmaTanish]

Hi @harshkhandeparkar ! I am very exited to work on this issue , if it is still open . I have learnt web development from coding ninjas and all my basic concepts are clear . I am very hardworking and have scored 94.2% in 12th . You can also go through my linkedIn profile - https://www.linkedin.com/in/tanish-a54b771b3 .
Looking forward for your reply .

[harshkhandeparkar]

Sure!

[pawanmkr]

is someone working on this issue? or having problems solving it? i also want to solve this issue

[Demon-Sheriff]

@harshkhandeparkar if the issue is still open, I would like to work on this