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

moving contributing docs into subfolder, docs #9

Merged
merged 1 commit into from
Mar 19, 2019
Merged

moving contributing docs into subfolder, docs #9

merged 1 commit into from
Mar 19, 2019

Conversation

vsoch
Copy link
Contributor

@vsoch vsoch commented Feb 27, 2019

Signed-off-by: Vanessa Sochat vsochat@stanford.edu

This is PR number 2, moving all of the contributing docs into a subfolder docs, to replace #6.

This will need GitHub pages turned on, building from the "docs" folder to render at https://opencontainers.github.io/org

Copy link
Member

@vbatts vbatts left a comment

Choose a reason for hiding this comment

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

Just a few nits, but I think this is a good start to merge

docs/docs/about.md Outdated Show resolved Hide resolved
docs/docs/about.md Outdated Show resolved Hide resolved
@vsoch
Copy link
Contributor Author

vsoch commented Mar 4, 2019

@vbatts what else should we discuss to make this ready for merge? I'd like to (soonish or after others add their thoughts to what is merged) work on a fun "Introduction to OCI" animated vignette.

@zendril
Copy link

zendril commented Mar 7, 2019

@vbatts

bump

Was away for work last week, back now and ready to start contributing to this. Anything we need to do to get it LGTMd and merged?

@vbatts
Copy link
Member

vbatts commented Mar 7, 2019

I think it's about ready to merge. Looking over https://vsoch.github.io/org/ as it may appear, I think there could be more links to projects and the overview or layout of what projects exist.

Also, as a convention in the image and runtime spec markdown, we put each sentence on its own line. Most markdown viewers still render adjacent lines as a paragraph, and for git change management it makes it more obvious for simple changes like typos and such.

@vsoch
Copy link
Contributor Author

vsoch commented Mar 7, 2019

Okay I'm probably going to royally screw this up again with the rebasing and squashing.

@vsoch
Copy link
Contributor Author

vsoch commented Mar 7, 2019

@vbatts you want me to go through and change every sentence on its own line?

@vbatts
Copy link
Member

vbatts commented Mar 7, 2019

@vsoch I'll open an issue to track that later then :-)

LGTM

@vbatts
Copy link
Member

vbatts commented Mar 7, 2019

(not sure why pullapprove went to lunch for this issue)

@vsoch
Copy link
Contributor Author

vsoch commented Mar 7, 2019

he was probably hungry.

Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

See review part 1.

docs/docs/about.md Outdated Show resolved Hide resolved
docs/docs/about.md Outdated Show resolved Hide resolved
docs/docs/about.md Show resolved Hide resolved
docs/docs/about.md Outdated Show resolved Hide resolved
docs/docs/about.md Outdated Show resolved Hide resolved
docs/docs/contributing/contributing.md Outdated Show resolved Hide resolved
docs/docs/contributing/contributing.md Outdated Show resolved Hide resolved
docs/docs/contributing/contributing.md Outdated Show resolved Hide resolved
docs/docs/contributing/contributing.md Outdated Show resolved Hide resolved
docs/docs/contributing/contributing.md Outdated Show resolved Hide resolved
@vsoch
Copy link
Contributor Author

vsoch commented Mar 8, 2019

okay fixed comments for @mikebrow. @vbatts I also put each sentence on one line (at least for a subset of the docs.) It renders okay but in my text editor it's sooo ugly. I'll have to be strong about this!

Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

review part2 halfway through container images getting tired :-) Finish tomorrow.

docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

part 3 ... review of container images section complete.

docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
docs/docs/introduction/container-images.md Outdated Show resolved Hide resolved
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

here's the last part of my review..

docs/docs/introduction/digests.md Outdated Show resolved Hide resolved
docs/docs/introduction/digests.md Outdated Show resolved Hide resolved
docs/docs/introduction/digests.md Outdated Show resolved Hide resolved
docs/docs/introduction/digests.md Outdated Show resolved Hide resolved
docs/docs/introduction/distribution.md Outdated Show resolved Hide resolved
docs/docs/introduction/oci-types.md Outdated Show resolved Hide resolved
docs/docs/introduction/oci-types.md Outdated Show resolved Hide resolved
docs/docs/introduction/oci-types.md Outdated Show resolved Hide resolved
docs/docs/introduction/oci-types.md Outdated Show resolved Hide resolved
docs/docs/introduction/oci-types.md Outdated Show resolved Hide resolved
@vsoch
Copy link
Contributor Author

vsoch commented Mar 15, 2019

ping! We are over 100 comments here - is this thoroughly reviewed yet?

@mikebrow
Copy link
Member

ping! We are over 100 comments here - is this thoroughly reviewed yet?

See unresolved comments.

@vsoch
Copy link
Contributor Author

vsoch commented Mar 18, 2019

GitHub does really terrible for long chains like this - there is an entire set of comments that I didn't even see because they compressed them above - I only saw them looking at files and seeing something like:

image

This process is not good enough for easily doing this, it's frustrating. There needs to be a strategy in place so that reviews don't add up like these (and comments get missed).

@vsoch
Copy link
Contributor Author

vsoch commented Mar 18, 2019

Multiple layers of this:
image

Is just not ok.

@vsoch
Copy link
Contributor Author

vsoch commented Mar 18, 2019

@mikebrow your comments are good and very specific, mostly just changing words. I think next time it would be much faster for both of us if you just forked the repo and make the changes and did a PR to my branch. This is taking way too long to just shuffle around some letters.

@mikebrow
Copy link
Member

@mikebrow your comments are good and very specific, mostly just changing words. I think next time it would be much faster for both of us if you just forked the repo and make the changes and did a PR to my branch. This is taking way too long to just shuffle around some letters.

Shared doc editing.. hmm wonder what we could use. :-)

@vsoch
Copy link
Contributor Author

vsoch commented Mar 18, 2019

My original thought was that I would add the skeleton (it was a lot of comment) and people would then do PRs for their detail work. I didn't think I'd be manually doing the detail work, so I guess this is my fault.

Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

/LGTM

@vsoch
Copy link
Contributor Author

vsoch commented Mar 18, 2019

🍏 📗 💚 🥗 🥑

@zendril
Copy link

zendril commented Mar 18, 2019 via email

@zendril
Copy link

zendril commented Mar 18, 2019 via email

@vbatts
Copy link
Member

vbatts commented Mar 19, 2019

@vsoch prolonged PRs are rough. lack of threads, hidden conversations, and falling of the radar are amplified.

@vsoch
Copy link
Contributor Author

vsoch commented Mar 19, 2019

Agree.

@vbatts
Copy link
Member

vbatts commented Mar 19, 2019

LGTM

@vbatts vbatts merged commit 234806f into opencontainers:master Mar 19, 2019
@vsoch
Copy link
Contributor Author

vsoch commented Mar 19, 2019

Woooot! Turn on thaaa GitHub pages!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants