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.

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

document usage *and* github actions #23

Merged
merged 11 commits into from
Mar 6, 2019
Merged

document usage *and* github actions #23

merged 11 commits into from
Mar 6, 2019

Conversation

maxheld83
Copy link
Contributor

as per #9

@maxheld83 maxheld83 mentioned this pull request Mar 4, 2019
Closed
@maxheld83
Copy link
Contributor Author

I know @svenevs suggested I place the usage documentation inside a separate usage.md (which I did), and this is obviously your show but ...

any chance we could just place this front and center in the README.md?

I could be wrong, but I think this (usage) might be the most common use case that people are looking for in this repo.

README.md would get a bit long, but maybe there's nothing wrong with that.

If you're ok with that, I'll update the PR accordingly.

svenevs
svenevs requested changes Mar 5, 2019
View reviewed changes
Copy link
Member

@svenevs svenevs left a comment

Choose a reason for hiding this comment

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

hey this is really cool, thank you so much for getting this together! will be adding separate comment about naming / doc location

usage.md Outdated Show resolved Hide resolved
usage.md Outdated Show resolved Hide resolved
usage.md Outdated Show resolved Hide resolved
usage.md Outdated Show resolved Hide resolved
usage.md Outdated Show resolved Hide resolved
@svenevs
Copy link
Member

svenevs commented Mar 5, 2019 •
edited
Loading

any chance we could just place this front and center in the README.md?

I could be wrong, but I think this (usage) might be the most common use case that people are looking for in this repo.

this is a good point. Maybe for this PR the order becomes:

  • Available Images
    • ...
  • Usage
    • Basic Usage
    • GitHub Actions (sorry , just saw this, a => A in title would be consistent)
  • Maintenance Notes

AKA just inject this section between Available Images and Maintenance Notes. Please use underline headers for consistency with other headings in that file (# -> === underline, ## -> --- underline).

README.md would get a bit long, but maybe there's nothing wrong with that.

That was part of the concern, but realistically in another PR I can just move all the maintenance notes to like MAINTENANCE.md or something. Since I agree that it's more helpful to users to have the usage info up front. But honestly even with all of them in there, it's not that long :)

@tarleb any opinions here? I think that this is great stuff for the main page, "here are the bare minimum you need to use the images / here's the low-hanging-fruit". Then more advanced tutorials can be created off main README.md for the sake of brevity.

@maxheld83
Copy link
Contributor Author

I’ll work in the suggested fixes later today

@tarleb
Copy link
Member

tarleb commented Mar 5, 2019

@tarleb any opinions here? I think that this is great stuff for the main page, "here are the bare minimum you need to use the images / here's the low-hanging-fruit". Then more advanced tutorials can be created off main README.md for the sake of brevity.

My thoughts exactly. This is great!

maxheld83 added a commit to maxheld83/dockerfiles that referenced this pull request Mar 5, 2019
@maxheld83
migrate usage to README.md as per pandoc#23
e9db30c
@maxheld83
Copy link
Contributor Author

should be good now.

tarleb
tarleb approved these changes Mar 5, 2019
View reviewed changes
Copy link
Member

@tarleb tarleb left a comment

Choose a reason for hiding this comment

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

I know I'm repeating myself, but this is great!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@svenevs svenevs merged commit 3286650 into pandoc:master Mar 6, 2019
@svenevs
Copy link
Member

svenevs commented Mar 6, 2019

AWESOME!!!! Thanks again so much @maxheld83 this is really nice stuff and very helpful 👑

@tarleb tarleb mentioned this pull request Mar 6, 2019
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tarleb tarleb tarleb approved these changes

@svenevs svenevs svenevs approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@maxheld83 @svenevs @tarleb