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

Import pre-RFC-process-dated DCP Media Types #113

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

kislyuk
Copy link
Member

@kislyuk kislyuk commented Sep 16, 2019

This RFC imports the DCP Media Types design document (https://docs.google.com/document/d/1TqihrgXjct9aDmTJO52_gE2WlpFysB1OkG9C8exmWTw/edit#) that was decided upon prior to the RFC process.

November 19th: Last call for community review

@kislyuk kislyuk mentioned this pull request Sep 16, 2019
@kislyuk
Copy link
Member Author

kislyuk commented Sep 17, 2019

Given that this document pre-dates the formal DCP RFC process and is de facto approved and implemented, I plan to bypass the usual process and merge it in after letting it sit for a week. If you have objections or minor edits to propose, please let us know by the end of this week. Barring objections, I'll merge the doc in on Monday, September 23.

@mweiden
Copy link
Contributor

mweiden commented Sep 17, 2019

@kislyuk @diekhans please go through the standard RFC process for this. Not doing so sets a precedent that may lead to unexpected outcomes later: people might be lead to believe that they can bypass the process if they implement something first and then publish the RFC.

If the RFC process is too slow, consider adding input to RFC: Proposing changes/updates to the RFC process.

@sampierson
Copy link
Member

sampierson commented Sep 17, 2019 via email

@sampierson
Copy link
Member

Ping @mweiden
Regarding my comment above.
This RFC was reviewed by the Arch team in October 2017, using the Google Docs review mechanism. Review was started here https://humancellatlas.slack.com/archives/C6SGU0R3J/p1508792188000502
Do you still want it to be reviewed again?

@mweiden
Copy link
Contributor

mweiden commented Oct 11, 2019

Discussed during the 2019-10-11 Arch meeting. We reached consensus on importing all old RFCs from google drive and labeling them "Imported."

@diekhans
Copy link
Contributor

I believe it is important to put all labels at the start of the document as well as github labels so it is easy to see when reading.

@maniarathi maniarathi closed this Nov 5, 2019
@maniarathi maniarathi force-pushed the akislyuk-rfc-dcp-media-types branch from b193e12 to 4c640ea Compare November 5, 2019 17:16
@maniarathi maniarathi reopened this Nov 5, 2019
@maniarathi maniarathi changed the title Import DCP media types RFC Import pre-RFC-process-dated DCP design decisions Nov 5, 2019
Copy link
Contributor

@diekhans diekhans left a comment

Choose a reason for hiding this comment

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

If we are going to import these into the current process, lets really import them by converting to markdown and committing. This way they can be used and maintained as with all other RFCs.
It doesn't really need to follow the template exactly, just be under source control and follow the naming convention.

This can be semi-automated by saving the page as HTML and doing

pandoc DCPMediaTypes.html -t markdown_github > DCPMediaTypes.md

Although the markdown is a bit ugly and needs some editing. Probably other tools too.

Copy link
Contributor

@diekhans diekhans left a comment

Choose a reason for hiding this comment

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

Above duplicated by github error 500.

Copy link
Contributor

@diekhans diekhans left a comment

Choose a reason for hiding this comment

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

Above duplicated by github error 500.

Copy link
Contributor

@diekhans diekhans left a comment

Choose a reason for hiding this comment

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

Above duplicated by github error 500.

Copy link
Contributor

@diekhans diekhans left a comment

Choose a reason for hiding this comment

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

Above duplicated by github error 500.

@maniarathi maniarathi changed the title Import pre-RFC-process-dated DCP design decisions Import pre-RFC-process-dated DCP Media Types Nov 6, 2019
@maniarathi
Copy link
Contributor

Updated to import DCP Media Types again.

Copy link
Member

@sampierson sampierson left a comment

Choose a reason for hiding this comment

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

This paragraph seems a little mangled.


# DCP Media Types

DISCLAIMER: Please note that this RFC has been imported its original Google Doc and went through a design review process prior to the implementation of the current [RFC Process](https://github.com/HumanCellAtlas/dcp-community/blob/master/rfcs/text/0001-rfc-process.md). The original document is [here](https://docs.google.com/document/d/1TqihrgXjct9aDmTJO52_gE2WlpFysB1OkG9C8exmWTw/edit#heading=h.87ix45a71erf). Please be aware that the contents below may potentially be out-of-date as the last-modified date of the original Google Document is October 20th, 2017.
Copy link
Member

Choose a reason for hiding this comment

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

Your "out of date" comment seems unnecessary. They same could be said of all RFCs the day after they are written.
And AFAICT this information is all still current at this time.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed; we should be checking for accuracy on import. I think the important thing to note is not that is was in google docs, but it was approved by an older process.

It would be good to update the google doc to point to the RFC.

Copy link
Contributor

Choose a reason for hiding this comment

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

@sampierson Deleted the last sentence. Thanks.

@diekhans I have an earlier sentence in that paragraph "and was approved by a design review process prior to the implementation of the current RFC Process."

@diekhans @sampierson I will let the original author decide whether to point the Google Doc to the RFC :)


## Motivation

The DCP should not invent new media types; we should append `dcp-type=metadata` or `dcp-type=data` to our Content-Types using the media type "parameter" syntax, e.g. `Content-Type: application/json; dcp-type=”metadata/sample”`. Instead the DCP should strive to use "in-band" media type communication mechanisms where possible.
Copy link
Member

Choose a reason for hiding this comment

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

This paragraph seems a little mangled. I think what you are trying to say is "The DCP should not xxx . Instead it should do yyy". Right now the Instead clause come after the "should do" clause.

Copy link
Contributor

Choose a reason for hiding this comment

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

Done.

@diekhans
Copy link
Contributor

diekhans commented Nov 7, 2019

note: I will be importing the domain RFC ~ Nov 13th

@diekhans
Copy link
Contributor

I don't see the value in putting these into a special directory "imported". This just creates a special case because of being reviewed with a different process. I think the idea is for these to be first-class RFCs just like all the others. We don't really want to have a new directory every time we change the RFC process.

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.

5 participants