Skip to content

Improve docs to be more explanatory - #1256

Closed
avinal wants to merge 3 commits into
github:mainfrom
avinal:patch-1
Closed

Improve docs to be more explanatory#1256
avinal wants to merge 3 commits into
github:mainfrom
avinal:patch-1

Conversation

@avinal

@avinalavinal commented Nov 11, 2020

Copy link
Copy Markdown
Contributor

Why:

Fixes#974

What's being changed:

  • Added {:copy} snippet to all code snippets
  • Improved Dockerfile snippet to make scripts executable here
# Container image that runs your codeFROM alpine:3.10
# Copies your code file from your action repository to the filesystem path `/` of the containerCOPY entrypoint.sh /entrypoint.sh
# Makes your code file executableRUN chmod +x entrypoint.sh
# Code file to execute when the docker container starts up (`entrypoint.sh`)ENTRYPOINT ["/entrypoint.sh"]
  • Removed a step here because it was unclear, this step is now covered by the previous change,

Check off the following:

@welcome

welcomeBot commented Nov 11, 2020

Copy link
Copy Markdown

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

@avinalavinal left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

corrected

@janiceilene

Copy link
Copy Markdown
Contributor

@avinal Thanks so much for opening a PR! I'll get this triaged for review 🌟

@github-actions

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actionsgithub-actionsBot added the stale There is no recent activity on this issue or pull request label Nov 21, 2020
@avinal

Copy link
Copy Markdown
ContributorAuthor

Is there more to add to this pr?

@github-actionsgithub-actionsBot removed the stale There is no recent activity on this issue or pull request label Nov 22, 2020
@janiceilene

Copy link
Copy Markdown
Contributor

There's nothing you need to add @avinal! Thanks for your patience as our small team works through all of the amazing contributions 🌟

@avinal

Copy link
Copy Markdown
ContributorAuthor

Thanks, @janiceilene for confirmation.

@github-actions

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actionsgithub-actionsBot added the stale There is no recent activity on this issue or pull request label Dec 6, 2020
@medoahmammmm

This comment has been minimized.

@github-actionsgithub-actionsBot removed the stale There is no recent activity on this issue or pull request label Dec 7, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

actionsThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamecosystemThis issue or pull request should be reviewed by the Docs Ecosystem team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

More details for newbies

4 participants

@avinal@janiceilene@medoahmammmm@martin389