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

[ReadMe] Should we remove (or update) FAQ? #246

Closed
RobDolinMS opened this issue Sep 1, 2016 · 9 comments
Closed

[ReadMe] Should we remove (or update) FAQ? #246

RobDolinMS opened this issue Sep 1, 2016 · 9 comments

Comments

@RobDolinMS
Copy link
Collaborator

The FAQ section of the ReadMe (which gets included in the released spec) seems like it has been minimally updated since being copied from the project proposal.

I'm glad to submit a PR to update (or remove) depending on consensus from Dev community.

@wking
Copy link
Contributor

wking commented Sep 1, 2016

On Thu, Sep 01, 2016 at 01:51:09PM -0700, Rob Dolin (MSFT) wrote:

I'm glad to submit a PR to update…

How would you update it? 1 looks reasonably current to me, although
I might replace “Why start this work now?” with “Why work on this?”
and “Why a new project?” with “Why a new OCI Project?”. And a more
logical ordering might be:

  • Why work on this?
  • Why a new OCI Project?
  • Why doesn't this project mention distribution?
  • What happens to AppC or Docker Image Formats?

@philips
Copy link
Contributor

philips commented Sep 1, 2016

Entries 2 and 3 can probably be removed. I think the rest is still relevent.

@wking
Copy link
Contributor

wking commented Sep 1, 2016

On Thu, Sep 01, 2016 at 01:59:52PM -0700, Brandon Philips wrote:

Entries 2 and 3 can probably be removed.

Those are the “why does this project exist” entries. I don't think
that motivation is stale. If they were stale, we'd be talking about
closing down this project.

@jonboulle
Copy link
Contributor

Partially touched on in #367

I think we should retain a FAQ in the README. If we don't want to publish it in the spec artefacts (PDF etc) then we should change the process by which we create those documents.

@vbatts
Copy link
Member

vbatts commented Mar 9, 2017

Is this still needed? I just read over the FAQ again, and while the second entry could have a Q more like "Isn't this the same as the runtime-spec", I feel like the A is mostly fine. I'm tempted to just close this issue for now.

@caniszczyk
Copy link
Contributor

also as an FYI we did an extensive update of the FAQ on the website recently: https://www.opencontainers.org/faq

@vbatts
Copy link
Member

vbatts commented Mar 9, 2017

so should we just point to that and be done with this?

@jonboulle
Copy link
Contributor

TBH the distribution question still comes up so often that we should continue to reference it it. But we can probably get rid of the "new project" and "why work on this" questions and point to the website FAQ.

vbatts added a commit to vbatts/oci-image-spec that referenced this issue Mar 9, 2017
@vbatts
Copy link
Member

vbatts commented Mar 9, 2017

done

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

No branches or pull requests

6 participants