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

Specification Pages Updates #27

Closed
brianking opened this issue Jul 17, 2017 · 15 comments
Closed

Specification Pages Updates #27

brianking opened this issue Jul 17, 2017 · 15 comments

Comments

@brianking
Copy link
Contributor

brianking commented Jul 17, 2017

Latest plan:

  1. http://open-services.net/specifications - Preserve this page, but this page should be significantly simplified to organize the specs in a simple list by the governing TC.

  2. http://open-services.net/specifications/requirements-management-2.0/ - this (for example) is the landing page for the document's governance page - this should redirect to the OASIS TC that now managing the page - probably the public URI.

  3. http://open-services.net/bin/view/Main/RmSpecificationV2 - This is the link to the specification itself which should be redirected to either the migrated OASIS specification, or the PDF document in the TC's Documents folder, e.g., https://www.oasis-open.org/committees/document.php?document_id=61070&wg_abbrev=oslc-domains

@rersie thinks it would be a good idea to keep also a landing page for the next level e.g.:
http://open-services.net/specifications/requirements-management-2.0/
"Those pages should also be simplified and mostly point to the locations at the OASIS TC’s
Alternatively, if a good landing page already exists at the OASIS TC, the URI could be a direct redirect to that location."

@jamsden
Copy link
Member

jamsden commented Jul 17, 2017

Re:

  1. The page should provide an "at a glance" view of the specifications including their title, version, brief description, status link to TC and link actual document

  2. Document links on the TC public pages are down a ways on the page under the section Technical Work Produced by the Committee. So having the actual document link (on the title of the document) in 1 above would be useful.

  3. The link should stay on the cloned 2.x specifications until the migrated OASIS document is a Committee Specification.

Keeping the current landing page at http://open-services.net/specifications/requirements-management-2.0/ could be optional. We have the summary page and the TC public home. That should be enough.

@brianking
Copy link
Contributor Author

@jamsden - can you give a couple of example, to get started?

@jamsden
Copy link
Member

jamsden commented Aug 10, 2017

Maybe a simple table with columns:

  • Specification Title (with URL link to the latest published specification)
  • Current status
  • Governing OASIS TC name (with link to TC public page)
  • Brief description (maybe optional - might make the table too big)
    Make each column sortable so that users can easily navigate the table based on specification, workgroup or status.

jailandrade added a commit that referenced this issue Aug 15, 2017
@jailandrade
Copy link
Contributor

I added a page to render the content from specifications and some styles for tables

@brianking
Copy link
Contributor Author

@jamsden We are working on it here, it will be prettier!

https://oslc.github.io/specifications/

In terms of content, for the one item where have in there, OSLC 3.0, can you say:

  • What is the "latest published specification" to link to in column 1?
  • What is the "link to TC public page" in column 3?

As for status, the main thing I am concerned about is that because this will be manually updated it might get stale from time to time.

@brianking
Copy link
Contributor Author

@jamsden

The skeleton file for you to fill out is now checked in at:
https://github.com/OSLC/oslc-site-hugo/blob/master/content/specifications/_index.md

When live, it maps to:
https://oslc.github.io/specifications/

@brianking
Copy link
Contributor Author

Initial table of OSLC specifications, status and links.
jamsden committed 13 hours ago
eb8d5b5

Changes are now on live test site:
https://oslc.github.io/specifications/

@berezovskyi
Copy link
Member

What is the reason for now publishing the 2.0 specs in HTML format by crawling the wiki as I suggested in OSLC/oslc-community#3 ?

Publishing specs for open RESTful services in PDF seems ludicrous to me.

@jamsden
Copy link
Member

jamsden commented Oct 7, 2017 via email

@brianking
Copy link
Contributor Author

I believe we decided to do both.

@berezovskyi
Copy link
Member

I was under the same impression as @brianking: PDF gets preserved in OASIS, HTML is crawled for the website archive section.

@brianking
Copy link
Contributor Author

@jamsden Are we good to go with this one?
http://oslc.co/specifications/

I'll open a separate issue to style the page to make it look prettier.

@jamsden
Copy link
Member

jamsden commented Oct 27, 2017 via email

@berezovskyi
Copy link
Member

  1. Where is Core 2.0?
  2. All 2.0 specs are still in PDF
  3. https://tools.oasis-open.org/version-control/browse/wsvn/oslc-promcode/WorkingDrafts/promcode-interface-v1.0-wd01_Chapter3.docx should be converted to PDF.

I will upload the patch to see how I resolved §1 shortly. I actually found the TWiki source and discovered that Pandoc knows how to convert TWiki to Markdown.

@brianking
Copy link
Contributor Author

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

4 participants