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

What does the document status "discontinued" mean? #262

Closed
rduerr opened this issue Mar 25, 2019 · 26 comments
Closed

What does the document status "discontinued" mean? #262

rduerr opened this issue Mar 25, 2019 · 26 comments
Assignees
Labels
Closed: Accepted The issue has been addressed, though not necessarily based on the initial suggestion DoC This has been referenced from a Disposition of Comments (or predates the use of DoCs) Topic: End-of-Life issues about rescinded/obsolete/discontinued Type: Editorial improvements
Milestone

Comments

@rduerr
Copy link

rduerr commented Mar 25, 2019

The document Delivery Context Ontology - W3C Working Group Note 29 June 2010
available at http://www.w3.org/TR/dcontology/ states the following:

"This document has been discontinued as part of the closure the Ubiquitous Web Applications Working Group."

This not one of the statuses in the current documentation and I am unclear on how to interpret it!

@frivoal
Copy link
Collaborator

frivoal commented Mar 26, 2019

The particular status this document has been retired to is "Working Group Note". This is grounded in section 6.3.3 of the Process.

However, as you say, it's not entirely obvious form the text in that particular specification that this is what happened. I wonder if we could make the term "discontinue" (regardless of conjugation) an anchor term in the Process that discontinued specifications could link to to explain what happened to them.

@chaals
Copy link
Contributor

chaals commented Mar 26, 2019

Note also that in 2010 the Process didn't have much about discontinuing a document - a common practice was just to abandon them. So moving the work to a Note was a pretty forward-thinking good thing to do in that case :)

@rduerr
Copy link
Author

rduerr commented Mar 26, 2019

Yes, but it still leaves me wondering about the use of terms in that ontology, which I might otherwise be using... The Process clearly needs to explain the term. I note that @frivoal explanation didn't actually help me decide whether to use terms from it or not!

@chaals
Copy link
Contributor

chaals commented Mar 27, 2019

it still leaves me wondering about the use of terms in that ontology, which I might otherwise be using

That's a question that is somewhat beyond the scope of the Process document, although I am going to give something of an answer because I suspect that @frivoal who is editing the document now might see something that could improve what the Process says:

W3C has decided that it will not continue working on the specification to make it a Recommendation.

You need to look for information about why that happened - a lack of uptake, a change of direction by implementors who had previously implemented the work, a feeling that there is no need for a standard in this area, an architectural flaw that nobody can see how to fix reasonably, a patent claim that covered essential material and meant you wouldn't have been able to use the spec royalty-free. You also want to consider whether the reason still applies. (Patents expire, dependencies on as-yet unavailable technology might be met with new technology a few years later, ...)

Then you want to consider whether what was described in the spec under development still meets your needs. Some specs are relevant for a very long time, others (for example hashing algorithms for security) clearly become inappropriate to use at some point.

Finally of course you want to look at what people are doing in the space - if they are all using a discontinued spec, or an informal modification, maybe you should propose that work re-start. If nobody is using it, maybe there is a good reason. If some do and some don't, you have to decide ...

@swickr
Copy link
Contributor

swickr commented Mar 29, 2019

+1 to what @chaals wrote. In particular,

W3C has decided that it will not continue working on the specification to make it a Recommendation

The text in the SoTD of that particular document might more clearly (and usefully) have been phrased in line with this as

This document was a deliverable of the Ubiquitous Web Applications Working Group. That group closed in 2010 without having advanced this document to Recommendation. The public record of the group's discussions is available in the group's archive.

@frivoal
Copy link
Collaborator

frivoal commented Jul 21, 2019

I'm proposing to close this issue with no change, as it's up to each individual discontinued document to explain what happened to them in their status section.

Alternatively, if we really want to be strict about this, we could add a sentence at the end of section 6.3.3 requiring the status section to state why the document was discontinued.

@frivoal frivoal added the Agenda+ Marks issues that are ready for discussion on the call label Jul 21, 2019
@dwsinger
Copy link
Contributor

Perhaps we should have

  • a definition of discontinued: "a document which the W3C is no longer actively working on and is unlikely to be revised or revived"
  • a sentence that says "if a group ceases work on a document and does not expect to take it up again, the status of the document should state it is discontinued, and optionally include text explaining why"

@frivoal
Copy link
Collaborator

frivoal commented Jul 24, 2019

I can work on an edit along these lines if we want it. It didn't seem to me that it would really change anything concretely, and that the problem is solved by being careful when writing status section, so I am tempted to skip, but if there's consensus to do this clarification, I have no objection.

@frivoal
Copy link
Collaborator

frivoal commented Jul 24, 2019

@plehegar, writing this comment as a reminder: you said you wanted some time to look at this, to figure out whether you preferred closing this with no action, or favored introducing some wording in the Process to tie it to the "retired" designation that is currently used on /TR/ for such documents.

@rduerr
Copy link
Author

rduerr commented Jul 25, 2019

As the author, I clearly would have been helped with wording in the Process that clearly explained what "discontinued" meant!

@css-meeting-bot
Copy link
Member

The Revising W3C Process CG just discussed What does the document status "discontinued" mean? #262.

The full IRC log of that discussion <fantasai> Topic: What does the document status "discontinued" mean? #262
<fantasai> github: https://github.com//issues/262
<fantasai> florian: We have a regular process for discontiuing documents that reached REC
<fantasai> florian: Different statuses depending on why discontinued
<fantasai> florian: For docs that haven't reached REC, to discontinue, you turn it into a NOTE
<fantasai> florian: You can describe what happened in the Status section, but that's it
<fantasai> florian: ...
<fantasai> florian: Result of work on continuous development
<fantasai> florian: makes it necessary to be more clear about why something is discontinued
<dsinger> I think it simply means “there’s nobody working on this any more” (perhaps we lost interest)
<fantasai> florian: Distinguishing between obsolete, superseded, rescinded becomes necessary
<fantasai> florian: Particularly important because these documents that are not yet REC have patent licensing associated to them
<jeff> q+
<jeff> ack fl
<fantasai> florian: So for now it's not urgent to fix, docs just need to be clear in their Status section
<fantasai> florian: but as we progress with continuous development, need to be clear
<dsinger> q?
<dsinger> ack jeff
<fantasai> florian: Even if plh thinks for current purposes this isn't needed, for ? it might be
<fantasai> jeff: Want to make sure I understood what Florian is saying
<fantasai> jeff: He said this is particularly applicable to Evergreen
<fantasai> jeff: We could have similar use case with Everblue
<fantasai> jeff: In Everblue, you take something to REC, then take it to CR, then never take it back to REC
<fantasai> jeff: the patent commitments for that CR don't kick in
<fantasai> florian: I don't think it's only applicable to Evergreen, but it's more critical
<fantasai> florian: Because the spec isn't expected to go to REC
<fantasai> florian: If in REC, can use usual REC obsoletion method
<dsinger> q?
<dsinger> ack fantasai
<fantasai> florian: but relevant for both
<dsinger> q+
<fantasai> https://github.com//issues/303
<dsinger> (Need to be able to Rescind not-yet-REC REC-track documents)
<fantasai> fantasai: Obsolete and superseded are informative distinctions
<fantasai> fantasai: Just makes status clearer to reader
<dsinger> q?
<fantasai> fantasai: But rescinded has patent licensing implications
<fantasai> fantasai: Right now only RECs have patent licenses
<fantasai> fantasai: so OK
<fantasai> fantasai: But as soon as we have patent licensing on other statuses, they also need to be able to rescind
<dsinger> ack ds
<fantasai> dsinger: I agree that rescinded and obsolete needs to be available to anything we recommend
<fantasai> dsinger: If someone stopped work on something, but not necessarily obsolete, just clarify that
<fantasai> dsinger: No longer actively working on it, nobody working on it
<fantasai> fantasai: So it might be obsolete, but you don't know
<fantasai> dsinger: Lighter weight than obsolete
<fantasai> dsinger: We'll get back to it with plh
<dsinger> q?

@dwsinger dwsinger added Topic: End-of-Life issues about rescinded/obsolete/discontinued and removed Agenda+ Marks issues that are ready for discussion on the call labels Aug 28, 2019
@dwsinger
Copy link
Contributor

Can we simply add to the section about end-of-life , and be done?

"Any document may be marked as 'discontinued'; this means simply that the community is no longer actively working on it, and does not expect to resume."

@dwsinger
Copy link
Contributor

accepted in principle, but we need to work on where this goes (there is existing text on stopping work, for example)

@css-meeting-bot
Copy link
Member

The Revising W3C Process CG just discussed discontinued.

The full IRC log of that discussion <fantasai> Topic: discontinued
<fantasai> github: https://github.com//issues/262
<fantasai> dsinger: [quotes https://github.com//issues/262#issuecomment-544825147 ]
<fantasai> dsinger: Is this what we mean by discontinued?
<fantasai> dsinger: should we put in process?
<fantasai> florian: I would push back on timing
<fantasai> florian: you could already link to relevant section of the Process from your use of "discontinued"
<fantasai> florian: But I think we need to change how discontinuing is done generally, so rather not worry about phrasing this section just yet
<dsinger> q?
<fantasai> florian: Lack of clarity in this issue wasn't about the Process, it was lack of clarity in the document
<fantasai> fantasai: ...
<fantasai> florian: Also, clarifying the word "discontinue" wouldn't necessarily help, that document could have used "abandoned"
<dsinger> so, we conclude: accepted in principle, but we need to work on where this goes (there is existing text on stopping work, for example)
<fantasai> florian: problem was not linking to the section of the Process that it's talking about, not that word is undefined
<tink> q+ to disagree and say I think we should clarify the phrase.
<dsinger> akc tink
<dsinger> ack tink
<Zakim> tink, you wanted to disagree and say I think we should clarify the phrase.
<fantasai> tink: I think it's worth clarifying
<fantasai> dsinger: Yes, but need to handle in right place in process
<fantasai> florian: We already have a sentence. It uses the word "cease" rather than "discontinue".
<fantasai> tink: We have clearly defined statesof a spec, and "discontinued" is not one of them
<fantasai> florian: This is not a REC that had been superseded, obsoleted, etc.
<fantasai> florian: It's a spec pre-REC that gote turned into a NOTE
<fantasai> florian: There is a section in the Process
<plh> https://www.w3.org/TR/?status=ret
<fantasai> florian: that talks about this
<fantasai> tink: There's no clear state.
<fantasai> florian: We should create statuses for this, but there will be more than one status
<fantasai> dsinger: taking offline for Florian and I can work on it
<dsinger> https://github.com//issues/141

@dwsinger dwsinger assigned frivoal and unassigned plehegar Nov 12, 2019
@frivoal frivoal added this to the Deferred milestone Mar 11, 2020
@dwsinger
Copy link
Contributor

I suggest a light edit to 6.2.12.1 to add after

Any technical report no longer intended to advance or to be maintained, and that is not being rescinded, should be published as a Working Group Note. This can happen if the Working Group decided to abandon work on the report, or the Director required the Working Group to discontinue work on the technical report before completion. If the Director closes a Working Group W3C must publish any unfinished technical report on the Recommendation track as Working Group Notes.

Such a document should be marked in its status section as (mark as definition of) 'Discontinued' accompanied by an explanation of why it was discontinued.

@frivoal frivoal modified the milestones: Deferred, Process 2021 Jul 15, 2020
@dwsinger dwsinger added the Agenda+ Marks issues that are ready for discussion on the call label Aug 24, 2020
@plehegar
Copy link
Member

Trying to define a definition of "discontinued" either forces to constrain the groups to this word, or forces us to add a flurry of different terms that are synonym of discontinued. Based on today's discussion, it's better to add a link to the relevant process section. it was decided to abandon work and the reasons should be spelled out in the SOTD for the community to read. How those reasons are described is up to the ones making the decision and we shouldn't attempt to constrain them to specific term.

@plehegar
Copy link
Member

The consequence of this issues is that we will:

  • require the SOTD to link to the relevant process section when a document is abandoned.
  • require the reason to be spelled out.

@dwsinger
Copy link
Contributor

I'm fine with not making 'discontinued' a defined/required term, but merely used in its english sense, and thus with what @plehegar suggests. So I think a sentence like:

Such a document should be documented as discontinued in its status section, with a link to this section of this document, and accompanied by an explanation of why it was discontinued.

@frivoal
Copy link
Collaborator

frivoal commented Aug 31, 2020

I think the proposed addition from @dwsinger is fine.

To be honest, I don't think it is necessary, and merely doing what @plehegar suggested and closing this with no fix as far as the process is concerned seems sufficient to me, but I don't oppose adding that text.

@dwsinger
Copy link
Contributor

I'm pretty easy either way, but I do like people to feel that if they raise something, we handle it

@dwsinger
Copy link
Contributor

Proposed Conclusion: A light edit to 6.2.12.1 to add after

Any technical report no longer intended to advance or to be maintained, and that is not being rescinded, should be published as a Working Group Note. This can happen if the Working Group decided to abandon work on the report, or the Director required the Working Group to discontinue work on the technical report before completion. If the Director closes a Working Group W3C must publish any unfinished technical report on the Recommendation track as Working Group Notes.

Such a document should be documented as discontinued in its status section, with a link to this section of this document, and accompanied by an explanation of why it was discontinued.

@nigelmegitt
Copy link
Contributor

Any technical report no longer intended to advance or to be maintained, and that is not being rescinded, should be published as a Working Group Note.

@dwsinger thanks to the isolated quote, I just noticed that this wording accidentally includes published Recs! I don't think it is meant to, from the context of the section it is in. It probably needs "unfinished" to be inserted before "technical report".

@plehegar
Copy link
Member

I just noticed that this wording accidentally includes published Recs!

The title of the section says "Abandoning an Unfinished Technical Report". I'm fine with repeating it in the text but RECs aren't included in this section.

@nigelmegitt
Copy link
Contributor

The title of the section says "Abandoning an Unfinished Technical Report". I'm fine with repeating it in the text but RECs aren't included in this section.

It seems like good practice to me not to depend on headings to constrain the scope of the text within them. Depending on headings is a brittle pattern; for example what might appear to be a simple editorial move of text later can accidentally have big ramifications. Better to make each normative statement stand on its own, referencing defined terms if necessary. There are other ways to deal with this, like defining document conventions but that would be a bigger change here.

So yes, I would ask for the text to repeat the word used in the heading. I'm glad you're fine with that @plehegar !

@dwsinger
Copy link
Contributor

accepted, and we need a new issue on what's noticed above

@nigelmegitt
Copy link
Contributor

Thanks @dwsinger , raised as #453.

@frivoal frivoal added Closed: Accepted The issue has been addressed, though not necessarily based on the initial suggestion DoC This has been referenced from a Disposition of Comments (or predates the use of DoCs) and removed Agenda+ Marks issues that are ready for discussion on the call labels Sep 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed: Accepted The issue has been addressed, though not necessarily based on the initial suggestion DoC This has been referenced from a Disposition of Comments (or predates the use of DoCs) Topic: End-of-Life issues about rescinded/obsolete/discontinued Type: Editorial improvements
Projects
None yet
Development

No branches or pull requests

8 participants