search

solid / webid-profile

Discovery based on Solid Social Agent WebID
https://solid.github.io/webid-profile/
MIT License
12 stars 9 forks source link

Editorial changes towards CG-DRAFT #116

Closed csarven closed 5 months ago

csarven commented 6 months ago

(An ocean of) editorial changes (correction class 1-2).

Change formatting / indenting to your liking. I tried to keep the diffs to minimal.

Will follow with a separate (small) PR for parts pertaining to CG-DRAFT proposal.

Preview | Diff

csarven commented 5 months ago

@jeff-zucker , can you please have a quick look over? It mostly brings the document up to date with random stuff. No change to normative content.

VirginiaBalseiro commented 5 months ago

Thanks @jeff-zucker . You are of course welcome to make PRs but they won't be included in the CG-DRAFT because we want to PR and publish soon. You can continue making contributions to the ED and those can be included in a future version.

jeff-zucker commented 5 months ago

Thanks @jeff-zucker . You are of course welcome to make PRs but they won't be included in the CG-DRAFT because we want to PR and publish soon. You can continue making contributions to the ED and those can be included in a future version.

Who is "we" - all of the editors other than me? When was it decided? It was not in any WebID Profile meeting I was aware of. Why is this being promoted to a CG-Draft without any consultation with me or response to issues I have raised, or opportunity to raise ones I have long been holding until there is a document for me to react to?

VirginiaBalseiro commented 5 months ago

It was not in any WebID Profile meeting I was aware of.

Jeff, as you know, WebID-Profile group has not been meeting in favor of using time in the CG calls and having meetings ad hoc if needed, which hasn't happened. This was discussed in chat and in meetings over a year ago.

Who is "we" - all of the editors other than me? When was it decided?

The CG. We have been discussing CG-DRAFT for all our documents for the past 3-4 weeks.

without any consultation with me

The PR is a consultation, and the PR for CG-DRAFT is another one.

or response to issues I have raised, or opportunity to raise ones I have long been holding until there is a document for me to react to?

I don't understand what you mean that you have been "holding" until there "a document for you to react to". This document we're editing is the document you could react to, create issues, or make PRs. In the past year or so I have had problems even getting my PRs reviewed, so I am a little bit surprised to hear you say that you haven't been asked for your response.

Do you wish to object to WebID-Profile specification to be published as CG-DRAFT? If so please make your reasons known and we can discuss it.

csarven commented 5 months ago

There may be a middle ground. Let's continue in https://github.com/solid/webid-profile/pull/117 (see my comment on consideration) and there are some related considerations for the CG, e.g., whether to keep editor's draft and CG-DRAFT as separate documents, licensing on code. General discussion around that is also covered in https://github.com/solid/specification/issues/587

jeff-zucker commented 5 months ago

I was under the impression that you were preparing an extensive use case document. Previously you had objected to my introduction and my suggested changes and said that the use cases would answer my objections. I never saw any major changes to the document and assumed you had simply stopped work on it to focus on your many other duties. No, I did not respond to your PRs because none of them addressed my concerns. I brought up some of my concerns in https://github.com/solid/webid-profile/issues/110 which got two positive responses from the community and zero responses of any kind from other editors of the document. Since I did not get a response to that, I did not submit furthyer ones, assuming that work was stalled and would be addressed later. Given this history, it is unbelievable to me that you tell me you are publishing a complete document and there is no time to wait for me to respond. I will submit PRs later this week. If you publish it before then, remove my name because it will be published over my objection.

jeff-zucker commented 5 months ago

I do not want to hold up the draft over issue #110 , that will take a longer discussion. But there are other changes I need to propose related to consistently distinguishing Solid Profile from Solid WebID Profile document and to the mentions of issuers and indexes. I do not expect them to be major or contentious but would like an opportunity to suggest them.

csarven commented 5 months ago

W3C documentation may not be clear out there but CG-DRAFTs can be revised indefinitely. I see absolutely no reason why the document (irrespective to being a CG-DRAFT or not) can't incorporate any changes. In the PR I've also mentioned how an ED like can be worked on in parallel to whatever CG-DRAFT or TR/ release is out there. Can we continue this discussion in that PR?

jeff-zucker commented 5 months ago

Okay, I'll move over to #117 . Can you tell me exactly which document I should PR against?

csarven commented 5 months ago

Hmm, I think it shouldn't matter much. Perhaps you can do it off the main branch for now and rebase if/when PR 117's contents are available from the main branch. I'm not sure if that's particularly different than branching off feature/cg-draft (from PR 117) and staying synchronised. (I'd go for main and rebasing.. because I'm no git master..)

VirginiaBalseiro commented 5 months ago

I was under the impression that you were preparing an extensive use case document.

Indeed the use cases that was taken as a work in parallel to the Solid WebID Profile specification, and if we want to publish it as a CG-DRAFT, it would need its own authors and editors. We have a list of use cases in the Introduction: https://solid.github.io/webid-profile/#use-cases covering a range of use cases, and that was initially brought up through in this PR: https://github.com/solid/webid-profile/pull/87 with the understanding that it covered https://github.com/solid/webid-profile/issues/52 and https://github.com/solid/webid-profile/issues/55 .

I never saw any major changes to the document and assumed you had simply stopped work on it to focus on your many other duties.

All changes can be tracked in for example https://github.com/solid/webid-profile/pulls?q=is%3Apr+is%3Aclosed and https://github.com/solid/webid-profile/commits/main/ .

Here are all of the changes since your last commit: https://services.w3.org/htmldiff?doc1=https%3A%2F%2Fraw.githubusercontent.com%2Fsolid%2Fwebid-profile%2Fe5c629010fcdb44d56b5773f978e6d1c6e2cb658%2Findex.html&doc2=https%3A%2F%2Fraw.githubusercontent.com%2Fsolid%2Fwebid-profile%2F7205cb732d837bbcbaaf7a9b184112831a5f4fe6%2Findex.html