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

Setup redirects for old OSLC specification wikis #225

Closed
jamsden opened this issue Dec 13, 2018 · 19 comments
Closed

Setup redirects for old OSLC specification wikis #225

jamsden opened this issue Dec 13, 2018 · 19 comments

Comments

@jamsden
Copy link
Member

jamsden commented Dec 13, 2018

Many people have saved links to the old open-services.net specification wikis, and they are surprised when these links return 404. There is a button on the error page that takes the user to corresponding page in the archive. However, each of the specifications should have direct redirects to the specification wikis. For example, the OSLC Core 2.0 specification should redirect https://open-services.net/specifications/core-2.0/index.html to https://archive.open-services.net/specifications/core-2.0/index.html.

@jamsden
Copy link
Member Author

jamsden commented Jan 14, 2019

  Domain Specification
Core https://archive.open-services.net/specifications/core-2.0/index.html https://archive.open-services.net/bin/view/Main/OslcCoreSpecification.html
Resource Shape https://archive.open-services.net/specifications/resource-shapes-2.0/index.html  
OSLC Query    
Tracked Resource Set https://archive.open-services.net/specifications/tracked-resource-set-2.0/index.html https://archive.open-services.net/wiki/core/TrackedResourceSet-2.0/index.html
Configuration Management https://archive.open-services.net/specifications/configuration-management/index.html  
Requirements Management https://archive.open-services.net/specifications/requirements-management-2.0/index.html https://archive.open-services.net/bin/view/Main/RmSpecificationV2.html
Change Management https://archive.open-services.net/specifications/change-management-2.0/index.html https://archive.open-services.net/bin/view/Main/CmSpecificationV2.html
Quality Management https://archive.open-services.net/specifications/quality-management-2.0/index.html https://archive.open-services.net/wiki/quality-management/index.html
Architecture Management https://archive.open-services.net/specifications/architecture-management-2.0/index.html https://archive.open-services.net/wiki/architecture-management/OSLC-Architecture-Management-Specification-Version-2.0/index.html
Asset Management https://archive.open-services.net/specifications/asset-management-2.0/index.html https://archive.open-services.net/wiki/asset-management/OSLC-Asset-Management-2.0-Specification/index.html
Automation https://archive.open-services.net/specifications/automation-2.0/index.html https://archive.open-services.net/wiki/automation/OSLC-Automation-Specification-Version-2.0/index.html
Performance Modeling https://archive.open-services.net/specifications/performance-monitoring-2.0/index.html https://archive.open-services.net/wiki/performance-monitoring/OSLC-Performance-Monitoring-Specification-Version-2.0/index.html
Estimation and Measurement https://archive.open-services.net/specifications/estimation-and-measurement-20/index.html https://archive.open-services.net/wiki/estimation-and-measurement/Estimation-and-Measurement-Service-Version-1.0_-REST-API/index.html
Reconciliation https://archive.open-services.net/specifications/reconciliation-2.0/index.html https://archive.open-services.net/wiki/reconciliation/OSLC-Reconciliation-Specification-Version-2.0/index.html

@jamsden
Copy link
Member Author

jamsden commented Jan 14, 2019

@FabioRNT
Copy link

  Domain Specification
Core https://archive.open-services.net/specifications/core-2.0/index.html https://archive.open-services.net/bin/view/Main/OslcCoreSpecification.html
Resource Shape https://archive.open-services.net/specifications/resource-shapes-2.0/index.html  
OSLC Query    
Tracked Resource Set https://archive.open-services.net/specifications/tracked-resource-set-2.0/index.html https://archive.open-services.net/wiki/core/TrackedResourceSet-2.0/index.html
Configuration Management https://archive.open-services.net/specifications/configuration-management/index.html  
Requirements Management https://archive.open-services.net/specifications/requirements-management-2.0/index.html https://archive.open-services.net/bin/view/Main/RmSpecificationV2.html
Change Management https://archive.open-services.net/specifications/change-management-2.0/index.html https://archive.open-services.net/bin/view/Main/CmSpecificationV2.html
Quality Management https://archive.open-services.net/specifications/quality-management-2.0/index.html https://archive.open-services.net/wiki/quality-management/index.html
Architecture Management https://archive.open-services.net/specifications/architecture-management-2.0/index.html https://archive.open-services.net/wiki/architecture-management/OSLC-Architecture-Management-Specification-Version-2.0/index.html
Asset Management https://archive.open-services.net/specifications/asset-management-2.0/index.html https://archive.open-services.net/wiki/asset-management/OSLC-Asset-Management-2.0-Specification/index.html
Automation https://archive.open-services.net/specifications/automation-2.0/index.html https://archive.open-services.net/wiki/automation/OSLC-Automation-Specification-Version-2.0/index.html
Performance Modeling https://archive.open-services.net/specifications/performance-monitoring-2.0/index.html https://archive.open-services.net/wiki/performance-monitoring/OSLC-Performance-Monitoring-Specification-Version-2.0/index.html
Estimation and Measurement https://archive.open-services.net/specifications/estimation-and-measurement-20/index.html https://archive.open-services.net/wiki/estimation-and-measurement/Estimation-and-Measurement-Service-Version-1.0_-REST-API/index.html
Reconciliation https://archive.open-services.net/specifications/reconciliation-2.0/index.html https://archive.open-services.net/wiki/reconciliation/OSLC-Reconciliation-Specification-Version-2.0/index.html

Just created and tested the redirects mentioned in this table, can anyone test it to see if everything is correct?

@jamsden
Copy link
Member Author

jamsden commented Jan 22, 2019

@FabioRNT
Copy link

For QM spec: https://open-services.net/wiki/quality-management/index.html should have been https://archive.open-services.net/bin/view/Main/QmSpecificationV2.html

All others were verified as correct.

Just fixed it.

@berezovskyi
Copy link
Member

@jamsden, @ndjc: so, I have slept on this and thought about a multitude of versions of the spec and how we consider them "complete", "authoritative", "obsolete" etc. So, I have switched from a table to a simple list with all the links present. See a side-by-side comparison:

image

We have a few more options: remove the "Governing TC" column and stack the links in the Status column (while renaming it to Editions, for example, and removing a link from the title). Also, we can use a dropdown instead of linked labels but that will prevent us from color-coding them.

I was thinking to use them in the following way:

  • green for current finalised specs
  • blue for reviewed drafts
  • orange for Final specs
  • light blue for drafts
  • grey for obsolete specs

https://getbootstrap.com/docs/3.4/components/#available-variations

@berezovskyi
Copy link
Member

And ofc we can show a tooltip for people who are not fluent in abbrspeak:

Skärmavbild 2019-05-21 kl  03 08 49

And this is how a dropdown can look like (did not have time to fix the styles but hope @gabrielfdac can help me out later):

image

@berezovskyi
Copy link
Member

Work is taking place in #244

@jamsden
Copy link
Member Author

jamsden commented May 21, 2019

I'm thinking about how this will scale. We will be publishing a lot of revisions of documents, project WD as needed to make the documents visible, PSPRD for public review, PS with various revisions. OASIS project standards, etc. Not all of these will need to be linked to open-services.net as many represent specification lifecycle artifacts rather than published standards.

Documents can be in three places:

  1. oslc-op GitHub - these are specifications under development, specific versions might be tagged, but these will be changing. This is primarily for the PGB and TSC, or anyone contributing to oslc-op
  2. Where OASIS publishes project specification standards track documents for managing specification lifecycle. This is primarily for the OASIS community for reviewing and managing standards track documents.
  3. open-services.net - where developers building client and server applications go to access OSLC related materials.

So I think we should only publish two versions on open-services.net - the finalized 2.x versions that are in common use today, and the latest published OASIS document, regardless of specification status (its noted in the document).

Older versions can be accessed through the archive, OASIS documents or GitHub as needed.

The Domains specifications are a bit different as they are suppose to be the 2.x specifications in the OASIS format. Its not clear we need to publish two versions of these.

Let's discuss.

@berezovskyi
Copy link
Member

Documents can be in three places

I don't think I fully agree with the dichotomy. I think open-services should be a landing place for all people: developers, folks who want to read/review specs and the developers. I honestly don't think the larger OASIS community cares about our specs (other than asking why do we need OSLC) unless we actively engage them.

The generation of the HTML code can be automated through some JSON data and templating. @gabrielfdac should be able to help with that. I think we are not publishing that "lot" that we can't add a link to every major revision of the spec (every CSPRD and higher).

Github tags is the last place we should be forcing people to go through. Moreover, nobody has ever done this before here (as opposed to us tagging releases in Eclipse Lyo) and I don't see a reason to believe some discipline will magically emerge out of nothing. I don't think that adding a link should be that harder than git tagging the repo & making an email/forum announcement.

Just to be clear, my proposal is just to LINK to the documents on open-services. There will be no documents published there. Everything will be hosted in the archive, OASIS, or Github (through GitHack).

we should only publish two versions on open-services.net

Older versions can be accessed through the archive, OASIS documents or GitHub as needed.

All versions will be accessed through the resource where they were originally published. Nothing will be published on open-services.net.

@jamsden
Copy link
Member Author

jamsden commented May 21, 2019

OSLC specification development can generate a lot of "noise" that is not interesting to people building OSLC client and server apps. This is the reason for separating the specification development vs. specification use concerns.

OASIS will be actually publishing a rendered copy of the specs. The process for doing that is something we need to discuss soon.

@berezovskyi
Copy link
Member

berezovskyi commented May 21, 2019 via email

@berezovskyi
Copy link
Member

A list of old spec links from @DavidJHoney:

All the specs under https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/#_trunk_specs_:
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/config/config-resources.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/config/config-vocab.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/config/oslc-config-mgt.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/config/versioned-resources.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/trs/tracked-resource-set-vocab.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/trs/tracked-resource-set.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/actions.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/attachments.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/core-vocab.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/dialogs.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/discovery.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/oslc-core-overview-v3.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/oslc-core.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/oslc-query.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/resource-preview.html
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/resource-shape.html

I think the spec drafts in trunk don't have much value but shall link to the new drafts here on the 'master' branch.

Specs under https://tools.oasis-open.org/version-control/browse/wsvn/oslc-ccm/tags/final/specs/#_tags_final_specs_:

Older specs under https://open-services.net/specifications/

  • List

Older specs (links now broken)

Broken links found by Google:

Other links found by Google:
http://docs.oasis-open.org/oslc-domains/oslc-am/v2.1/oslc-am-v2.1-part1-architecture-management-spec.html

Broken links in https://www.w3.org/Submission/shapes/#OSLC:

@berezovskyi
Copy link
Member

cc @jamsden and @ndjc we might as well deal with these too

@DavidJHoney @jamsden what does the tag final mean in the links above?

@berezovskyi
Copy link
Member

@berezovskyi
Copy link
Member

due to oslc-op/oslc-specs#65 I have escalated the priority for this and added a pair of redirects for both wikis

@berezovskyi
Copy link
Member

@DavidJHoney all of your links now resolve except for https://archive.open-services.net/bin/view/Main/AmSpecV2#AM_Resource_Definitions which redirects to a 404 wiki page redirecting visitors to https://archive.open-services.net/wiki/architecture-management/OSLC-Architecture-Management-Specification-Version-2.0/index.html. I will try to set up a redirect for this that would not cause a 404.

@DavidJHoney
Copy link
Member

Re: what does the tag final mean in the links above?
I don't know. I just copied the URIs from FF bookmarks or other pages that referenced them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants