The Wayback Machine - https://web.archive.org/web/20201208023353/https://github.com/github/docs/issues/974
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

Open
AlexiyOrlov opened this issue Nov 2, 2020 · 12 comments · May be fixed by #1256
Open

More details for newbies #974

AlexiyOrlov opened this issue Nov 2, 2020 · 12 comments · May be fixed by #1256

Comments

@AlexiyOrlov
Copy link

@AlexiyOrlov AlexiyOrlov commented Nov 2, 2020

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 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 label Nov 2, 2020
@github-actions github-actions bot added this to Triage in Docs team reviews Nov 2, 2020
@janiceilene janiceilene moved this from Triage to Ecosystem in Docs team reviews Nov 3, 2020
@janiceilene janiceilene added the actions label Nov 3, 2020
@janiceilene
Copy link
Collaborator

@janiceilene janiceilene commented Nov 3, 2020

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

@rachmari rachmari added triage and removed triage labels Nov 5, 2020
@runleonarun
Copy link
Contributor

@runleonarun runleonarun commented Nov 6, 2020

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 and removed triage labels Nov 6, 2020
@runleonarun runleonarun removed this from Ecosystem in Docs team reviews Nov 6, 2020
@janiceilene janiceilene added this to Available issues in Docs team reviews Nov 6, 2020
@avinal
Copy link

@avinal avinal commented Nov 10, 2020

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

@janiceilene
Copy link
Collaborator

@janiceilene janiceilene commented Nov 10, 2020

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

@avinal avinal linked a pull request that will close this issue Nov 11, 2020
4 of 4 tasks complete
@avinal
Copy link

@avinal avinal commented Nov 11, 2020

I have added a pr please take a look.

@lostnco1
Copy link

@lostnco1 lostnco1 commented Nov 11, 2020

@AlexiyOrlov thanks for this issue, I think I need to try and get a template set up and find a way for me to file everything in the correct order. I mostly use android and I need to figure out the right way to get the best results

@AlexiyOrlov
Copy link
Author

@AlexiyOrlov AlexiyOrlov commented Nov 12, 2020

Ah, no problem.

@himanshu211raj
Copy link

@himanshu211raj himanshu211raj commented Nov 25, 2020

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

@rectorhotel rectorhotel commented Nov 26, 2020

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

@janiceilene
Copy link
Collaborator

@janiceilene janiceilene commented Nov 30, 2020

@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 rectorhotel commented Dec 2, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Docs team reviews
Available issues
Linked pull requests

Successfully merging a pull request may close this issue.

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