OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

virtio message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: Request for a wording change on the README file for the spec GitHub

On Tue, Apr 03, 2018 at 10:54:31AM -0400, Chet Ensign wrote:
> Hi Michael, 
> I just had a query about the TC's GitHub at https://github.com/oasis-tcs/
> virtio-spec. The question was why the README file describes the content as the
> "authoritative" source of the VIRTIO spec document when the authoritative
> source is http://docs.oasis-open.org/virtio/virtio/v1.0/cs04/tex/
> (Authoritative)? 
> It is a valid, if rather technical, point. Would you mind changing that to
> something along the lines of "This repository includes the most up-to-date
> editorial source for the VIRTIO Specification document." That is an
> accurate description that no one can complain about. You might also include a
> link to the most current approved version on docs.oasis-open.org. 

I thought about this some more. I really want to be able to
point people to the copy within github.
That's much more useful than the copy in the docs.oasis since
with that one can not e.g. see the differences between versions.
How about linking to the releases directory?

diff --git a/README.md b/README.md
index a4fdc4e..d40f095 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
-<p>This repository includes the authoritative source of the VIRTIO (Virtual I/O) Specification document.
+<p>This repository includes the <a href="https://github.com/oasis-tcs/virtio-spec/releases";>authoritative source</a> of the VIRTIO (Virtual I/O) Specification document.

Would this address the issue?


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]