Skip to content

Improve docs to be more explanatory #2988

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Jan 20, 2021
Merged

Improve docs to be more explanatory #2988

merged 9 commits into from
Jan 20, 2021

Conversation

avinal
Copy link
Contributor

@avinal avinal commented Jan 19, 2021

Why:

Fixes #974

What's being changed:

  • Added {:copy} snippet to all code blocks.
  • Added a few descriptions about public and private actions
  • Changed the order of commands and added a description in creating the script.

Check off the following:

@avinal
Improve docs to be more explanatory
c3dcc20 
- Added `{:copy}` snippet to all code blocks. 
- Added a few descriptions about public and private actions
- Changed the order of commands and added a description.
@avinal avinal mentioned this pull request Jan 19, 2021
Closed
@martin389
Copy link
Contributor

Stage preview is available here: https://docs-2988--avinal-improve-docs.herokuapp.com/en/actions/creating-actions/creating-a-docker-container-action

avinal and others added 2 commits January 19, 2021 12:43
@avinal
Update content/actions/creating-actions/creating-a-docker-container-a…
d1ef194 
…ction.md

Co-authored-by: Martin Lopes <martin389@github.com>
@avinal
Update content/actions/creating-actions/creating-a-docker-container-a…
58c63b1 
…ction.md

Co-authored-by: Martin Lopes <martin389@github.com>
@avinal
Copy link
Contributor Author

avinal commented Jan 19, 2021

Seems relative links couldn't be resolved by the tests.

@janiceilene janiceilene added actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team labels Jan 19, 2021
@martin389 martin389 self-assigned this Jan 20, 2021
lucascosti
lucascosti reviewed Jan 20, 2021
View reviewed changes
Copy link
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

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

👋 @martin389 Just a couple of small things, and then this will be ready to 🚢! 🙂

content/actions/creating-actions/creating-a-docker-container-action.md Outdated
@@ -200,11 +202,11 @@ jobs:

#### Example using a private action

Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name.
Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.
Copy link
Contributor

@lucascosti lucascosti Jan 20, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Like the public action comment, we should try to version mentions of publishing to GitHub Marketplace as only for free-pro-team@latest (it's not applicable to Enterprise Server).

@martin389 martin389 requested a review from lucascosti January 20, 2021 03:42
lucascosti
lucascosti approved these changes Jan 20, 2021
View reviewed changes
Copy link
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

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

Thanks @martin389! I missed one thing in my last review which should probably be removed; other than that, this is good to go!

Martin Lopes and others added 2 commits January 20, 2021 15:43
@martin389 martin389 merged commit 3d243a3 into github:main Jan 20, 2021
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

@martin389
Copy link
Contributor

@avinal - Thank you for this great PR 👍

The updated article can be found here, once the background tasks have completed: https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action

@avinal
Copy link
Contributor Author

avinal commented Jan 20, 2021

Thanks @martin389, it is my pleasure.

@avinal avinal mentioned this pull request Aug 30, 2021
Closed
1 task
@snyk-bot snyk-bot mentioned this pull request Apr 1, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martin389 martin389 martin389 left review comments

@lucascosti lucascosti lucascosti approved these changes

Assignees

@martin389 martin389

Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

More details for newbies
4 participants
@avinal @martin389 @lucascosti @janiceilene