Skip to content

Improve docs to be more explanatory - #2988

Merged
martin389 merged 9 commits into
github:mainfrom
avinal:avinal-improve-docs
Jan 20, 2021
Merged

Improve docs to be more explanatory#2988
martin389 merged 9 commits into
github:mainfrom
avinal:avinal-improve-docs

Conversation

@avinal

@avinalavinal commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

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.
@avinalavinal mentioned this pull request Jan 19, 2021
Closed
@martin389

martin389 commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

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

martin389
martin389 reviewed Jan 19, 2021
View reviewed changes
Comment threadcontent/actions/creating-actions/creating-a-docker-container-action.md Outdated
martin389
martin389 reviewed Jan 19, 2021
View reviewed changes
Comment threadcontent/actions/creating-actions/creating-a-docker-container-action.md Outdated
avinaland others added 2 commits January 19, 2021 12:43
@avinalMartin Lopes
Update content/actions/creating-actions/creating-a-docker-container-a…
d1ef194
…ction.md
Co-authored-by: Martin Lopes <martin389@github.com>
@avinalMartin Lopes
Update content/actions/creating-actions/creating-a-docker-container-a…
58c63b1
…ction.md
Co-authored-by: Martin Lopes <martin389@github.com>
@avinal

avinal commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

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

@janiceilenejaniceilene 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
@martin389martin389 self-assigned this Jan 20, 2021
lucascosti
lucascosti reviewed Jan 20, 2021
View reviewed changes

@lucascostilucascosti left a comment

Copy link
Copy Markdown
Contributor

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 🚢! 🙂

Comment threadcontent/actions/creating-actions/creating-a-docker-container-action.md Outdated
Comment threadcontent/actions/creating-actions/creating-a-docker-container-action.md Outdated
#### 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.

@lucascostilucascostiJan 20, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

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

lucascosti
lucascosti approved these changes Jan 20, 2021
View reviewed changes

@lucascostilucascosti left a comment

Copy link
Copy Markdown
Contributor

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!

Comment threadcontent/actions/creating-actions/creating-a-docker-container-action.md Outdated
Martin Lopesand others added 2 commits January 20, 2021 15:43
@martin389
martin389 merged commit 3d243a3 into github:mainJan 20, 2021
@github-actions

github-actionsBot commented Jan 20, 2021

Copy link
Copy Markdown
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

martin389 commented Jan 20, 2021

Copy link
Copy Markdown
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

avinal commented Jan 20, 2021

Copy link
Copy Markdown
ContributorAuthor

Thanks @martin389, it is my pleasure.

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

Reviewers

2 more reviewers
@martin389martin389martin389 left review comments
@lucascostilucascostilucascosti approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@martin389martin389

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

More details for newbies

4 participants

@avinal@martin389@lucascosti@janiceilene