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

More details for newbies #974

Closed
AlexiyOrlov opened this issue Nov 2, 2020 · 15 comments · Fixed by #2988
Closed

More details for newbies #974

AlexiyOrlov opened this issue Nov 2, 2020 · 15 comments · Fixed by #2988
Assignees
Labels
actions This issue or pull request should be reviewed by the docs actions team good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@AlexiyOrlov
Copy link

What article on docs.github.com is affected?

https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/creating-a-docker-container-action

What part(s) of the article would you like to see updated?

As a total newbie to actions and Docker, I made a couple of silly mistakes when trying out the example.
First, in the entrypoint.sh file, I wrote -1 instead of -l.
Second, the docker couldn't run the .sh file because of permissions, so I had to add RUN chmod +x /entrypoint.sh to the dockerfile.
Also line uses: actions/hello-world-docker-action@v1 shows how to use published action. You should add that unpublished action is used via uses: [username]/[reponame]@version.
So I think these 3 things should be pointed out there.

@welcome
Copy link

welcome bot commented Nov 2, 2020

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 2, 2020
@janiceilene janiceilene added the actions This issue or pull request should be reviewed by the docs actions team label Nov 3, 2020
@janiceilene
Copy link
Contributor

Thanks for opening an issue @AlexiyOrlov! I'll triage this for the right team to take a look.

@rachmari rachmari added triage Do not begin working on this issue until triaged by the team and removed triage Do not begin working on this issue until triaged by the team labels Nov 5, 2020
@runleonarun
Copy link
Contributor

Hi @AlexiyOrlov! Thanks for this issue. I'd definitely like to smooth out the process for newbies!

Second, the docker couldn't run the .sh file because of permissions, so I had to add RUN chmod +x /entrypoint.sh to the dockerfile.

🤔 We do have that in Step 2 where it tells you how to make the file executable.

Here are some suggestions for the other two ideas:

First, in the entrypoint.sh file, I wrote -1 instead of -l.

Because we do use "l" and not "1" in the example, I don't think we need to add any explanatory text. One thought is that we could add {:copy} to this code snippet so the copy icon shows up like it does here. For example:

```shell{:copy}

Also line uses: actions/hello-world-docker-action@v1 shows how to use published action. You should add that unpublished action is used via uses: [username]/[reponame]@Version.

This absolutely can be added to the docs! Thank you for suggesting it.

@runleonarun runleonarun added good first issue Good for newcomers and removed triage Do not begin working on this issue until triaged by the team labels Nov 6, 2020
@avinal
Copy link
Contributor

avinal commented Nov 10, 2020

I would like to work on this issue if no one is working on it.

@janiceilene
Copy link
Contributor

I don't see any open PRs for this issue, please feel free to open one @avinal 💖

@avinal
Copy link
Contributor

avinal commented Nov 11, 2020

I have added a pr please take a look.

@AlexiyOrlov
Copy link
Author

Ah, no problem.

@himanshu211raj
Copy link

I like to work on this issue if no one working on it! As I am a beginner and need some guidance regarding how to contribute to open source.

@rectorhotel
Copy link

Also a newbie, super excited to learn all the ins and outs of the github

@janiceilene
Copy link
Contributor

@rectorhotel It looks like there's already a pull request opened and it's just waiting for review. There are lots more issues available with the help wanted label!

You can also take a look at the contributing.md to learn how to contribute in this repo and open a discussion if you have any questions ✨

We're excited you're here!

@rectorhotel
Copy link

rectorhotel commented Dec 2, 2020 via email

@janiceilene janiceilene added the help wanted Anyone is welcome to open a pull request to fix this issue label Dec 4, 2020
@martin389
Copy link
Contributor

Thanks for creating this issue!

Second, the docker couldn't run the .sh file because of permissions, so I had to add RUN chmod +x /entrypoint.sh to the dockerfile.

I think it would be preferable to keep chmod +x /entrypoint.sh outside of the docker container, as this avoids having to create an extra layer for the RUN command. (This part is described in step 2)

@avinal
Copy link
Contributor

avinal commented Jan 19, 2021

Hello @martin389, I have added a PR #2988.

@martin389
Copy link
Contributor

Great, thank you @avinal!

jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
Co-authored-by: Lana Brindley <github@lanabrindley.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants