Arazzo-Specification icon indicating copy to clipboard operation
Arazzo-Specification copied to clipboard

Revamp the OAI website to host multiple specifications along with OAS (e.g. Workflows, SLA, etc)

Open frankkilcommins opened this issue 1 year ago • 5 comments

The exit process for new specifications coming out of Special Interest Groups require a home within the OpenAPIs website.

At a minimum, we need to:

  • update the specs page - https://spec.openapis.org/
  • create a pretty print version of the spec (via #42)

Optionally:

  • Update the main website menu options / landing page to advertise multiple specs - https://www.openapis.org/

frankkilcommins avatar Jan 18 '24 17:01 frankkilcommins

@frankkilcommins Need to update the text to Arazzo on the homepage

jeremyfiel avatar May 22 '24 03:05 jeremyfiel

@swaldron58 @dret in order to close out this issue, I still think we need some enhancements to the navigation menus on the main website.

Suggested changes:

  • Change Specification nav item text to Specifications
  • Create a new page to explain that the OAI is now a multi-specification org. This page could link to https://www.openapis.org/what-is-openapi as well as https://www.openapis.org/arazzo
  • Change the link for the Specifications nav item from https://spec.openapis.org/oas/latest.html to the new page created above
  • Change Specification > latest to Specifications > OpenAPI Specification (or latest OpenAPI)
  • Change Specifications > Arazzo Specification to point to https://spec.openapis.org/arazzo/latest.html
  • Change Specifications > Getting started with the spec to Specifications > Getting started with OpenAPI

frankkilcommins avatar Jul 31 '24 12:07 frankkilcommins

On 2024-07-31 14:18, Frank Kilcommins wrote:

@swaldron58 https://github.com/swaldron58 @dret https://github.com/dret in order to close out this issue, I still think we need some enhancements to the navigation menus on the main website. Suggested changes:

These look all like very reasonable suggestions. I struggle with the current menu system a fair bit myself. But I have no access to the site and cannot make any changes.

If we want to be ambitious we could embed the hangout video on the "Arazzo intro page", or one of the shorter videos.

  • Hangout video (59min): https://www.youtube.com/watch?v=j6Iz99gdkjU
  • Frank introducing the spec (7min): https://www.youtube.com/watch?v=C_rkvN9zwKg

One could really embed the video or simply publish a still and link it to the video. We've done that here, for example, and it seems like people like to have the ability to watch a video:

https://www.datamesh-architecture.com/#what-is-data-mesh

dret avatar Jul 31 '24 12:07 dret

Note that there's an issue for updating the spec.openapis.org site already: OAI/OpenAPI-Specification#3576

handrews avatar Jul 31 '24 17:07 handrews

I did the easy one, the drop downs. I'll get to the rest when I can.

swaldron58 avatar Aug 01 '24 01:08 swaldron58

Closing this as good enough for now. There's other issues open to adjust based on structural changes to create new dedicated website for specifications as well as larger overhaul of branding site.

frankkilcommins avatar Dec 17 '24 10:12 frankkilcommins