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

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

Open
HarshKhandeparkar opened this issue Jan 17, 2020 · 6 comments · May be fixed by #1529
Open

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

HarshKhandeparkar opened this issue Jan 17, 2020 · 6 comments · May be fixed by #1529

Comments

@HarshKhandeparkar
Copy link
Member

@HarshKhandeparkar HarshKhandeparkar commented Jan 17, 2020

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.
Screenshot from 2020-01-17 23-35-45

Files to refer to:

  1. <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

This comment has been minimized.

Copy link

@pcube99 pcube99 commented Jan 17, 2020

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

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Jan 17, 2020

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

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Jan 17, 2020

All the other steps' description should be clickable.

@pcube99

This comment has been minimized.

Copy link

@pcube99 pcube99 commented Jan 17, 2020

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

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Jan 17, 2020

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

pcube99 added a commit to pcube99/image-sequencer that referenced this issue Jan 17, 2020
@pcube99 pcube99 linked a pull request that will close this issue Jan 17, 2020
4 of 5 tasks complete
@pcube99

This comment has been minimized.

Copy link

@pcube99 pcube99 commented Jan 17, 2020

@HarshKhandeparkar please check the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.