diff --git a/src/website/design/content-redesign-notes.md b/src/website/design/content-redesign-notes.md new file mode 100644 index 0000000..0b1abdc --- /dev/null +++ b/src/website/design/content-redesign-notes.md @@ -0,0 +1,126 @@ +# Website Layout + +This document provides an overview of the content design for the revised openapis.org website. + +## Menu + +This section provides the content of the menu bar. + +### Drop downs + +The following are the drop downs we should aim for. + +```text +Learn +├── What Is OpenAPI Initiative? (Relocate existing page). +├── [Learn About OAI](https://learn.openapis.org/) +├── [Online Courses](https://training.linuxfoundation.org/full-catalog/?_sf_s=openapi) +Specifications +| +├── [OpenAPI](https://spec.openapis.org/oas) +├── [Arazzo](https://spec.openapis.org/arazzo) +├── [Overlay](https://spec.openapis.org/overlay) +├── [Registries](https://spec.openapis.org/registry/) +Community +├── [Collaborate on Slack](https://communityinviter.com/apps/open-api/openapi) +├── Participate + ├── [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/main/README.md#participation) + ├── [Arazzo](https://github.com/OAI/Arazzo-Specification?tab=readme-ov-file#getting-involved) + ├── [Overlay](https://github.com/OAI/Overlay-Specification) +├── Current Members (Relocate existing page) +├── Become a Member (Relocate existing page) +Events +Blog +``` + +## Homepage + +Proposed design notes for homepage. + +### Banner + +> Looking at the top section of https://graphql.org/ for inspiration here, think the headline section works really well. + +Title: API Description Languages for the API Economy. + +- Open, language-agnostic API description with the OpenAPI Specification. + +- Extend descriptions to multistep API-driven workflows with the Arazzo Specification. + +- Automate maintenance and increase efficiency with the Overlay Specification. + +The OpenAPI Initiative supports the development of the OpenAPI, Arazzo, and Overlay Specifications, which are trusted by millions of developers when creating, describing and consuming APIs. + +### Our Specifications + +> These are just rough ideas, to iterate over some content for the page. Ignore the formatting, it's the layout calls to action that are important. + +The OpenAPI Initiative is a family of three specifications: OpenAPI, Arazzo, and Overlay. + +#### OpenAPI + +
OpenAPI is the foremost API description language available to the API community today, and powers how knowledge of APIs are shared between API creators and the organization that use them. OpenAPI is a rich, vendor and programming language and vendor agnostic language, that reflects how APIs are created and published, and is supported by a huge and vibrant tooling community.
+OpenAPI is the foremost API description language available to the API community today, and powers how knowledge of APIs are shared between API creators and the organization that use them. OpenAPI is a rich, vendor and programming language and vendor agnostic language, that reflects how APIs are created and published, and is supported by a huge and vibrant tooling community.
+