Change Details

Based on the [current content strategy](https://wikitech.wikimedia.org/wiki/API_Portal#Content_strategy) and the new scope defined in T289183: **API Portal mission statement** The API Portal is an information hub for API producers and consumers to discover, consume, and manage Wikimedia APIs. **Personas** - API producers - API consumers - Technical writers - Product managers **Capabilities** - Allow for the discovery of **ALL** (new, old, experimental, public, internal, Gateway, non-Gateway, WMF, non-WMF) Wikimedia HTTP APIs through an API catalog - Serve API reference documentation created using the to-be-developed API Platform documentation tooling - Act as a multilingual wiki for API-related learning materials, like tutorials and best practices - Create and manage Wikimedia OAuth 2.0 clients Define new content strategy for the API Portal.

Based on the [current content strategy](https://wikitech.wikimedia.org/wiki/API_Portal#Content_strategy) and the new scope defined in T289183, define a new content strategy for the API Portal. ## API Portal mission statement The Wikimedia API Portal is an information hub for people creating, serving, and using Wikimedia-specific APIs. ## Personas - People who create APIs - People who use APIs - People who write API documentation - People who are responsible for the stability of WMF servers ## Capabilities - Allow for the discovery of **ALL** (new, old, experimental, public, internal, Gateway, non-Gateway, WMF, non-WMF) Wikimedia HTTP APIs through an API catalog - [Deprioritized] Serve API reference documentation created using the to-be-developed API Platform documentation tooling - Act as a multilingual wiki for API-related learning materials, like tutorials and best practices - Create and manage Wikimedia OAuth 2.0 clients ## Information architecture ### Overview - **/Learn**: code samples, tutorials, and topics that teach people how to use Wikimedia APIs - **/API catalog**: a list of available Wikimedia APIs, each with an API pages providing information about the API and links to docs - **/Community**: resources for connecting the API community and helping them share their work, including announcements, featured projects, and contributing instructions - **/API guidelines**: resources for API creators, including the API guidelines, process for adding an API, and other best practices ### /Learn The Learn section provides code samples, tutorials, and topics that teach people how to use Wikimedia APIs. This content is meant to be supplementary to API reference docs and primarily used by beginners and first-time users. Within the Learn section, editors can contribute code samples, tutorials, and topics using a set of standard templates. Pages under Learn have a flat structure. The Learn landing page includes the get started flow, a list of featured tutorials, related sets of pages, and ways to browse pages by tags. (The specific tagging system and mechanism are to be determined.) ### /API catalog The API catalog lets users browse a list of available Wikimedia APIs. To reflect the current state of Wikimedia APIs, each API in the catalog is considered a stand-alone API in terms of functionality and conventions. Each API in the catalog links to an API page. An API page is the home of an API; it acts as a central information hub and communication point between an API’s users and creators. The API page includes information about the API, commenting via the talk page, a link to the reference documentation, and links to relevant Learn pages. Subpages of the API page can be used for API reference documentation or for topics specific to that API. However, API reference documentation does not have to be stored in the API Portal. As long as the API reference meets the requirements for guaranteed accuracy (as set by the API guidelines), the docs can be stored anywhere and be discovered through the link on the API page. ## Content types - landing page - API page - topic - tutorial - code sample - process page - guideline ## Proposed structure and map to existing pages [Google Sheet](https://docs.google.com/spreadsheets/d/1u9XtdmuAOj5RQTL9tRVgnXD3TlZ_HdyU_DepVS8N8vM/edit#gid=0) (publicly viewable)

Based on the [current content strategy](https://wikitech.wikimedia.org/wiki/API_Portal#Content_strategy) and the new scope defined in T289183:, define a new content strategy for the API Portal. **API Portal mission statement** The API Portal is an information hub for API producers and consumers to discover, consume, and manage Wikimedia APIs.## API Portal mission statement **Personas**The Wikimedia API Portal is an information hub for people creating, serving, and using Wikimedia-specific APIs. ## Personas - API producers- People who create APIs - API consumers- People who use APIs - Technical- People who writerse API documentation - Product managers **- People who are responsible for the stability of WMF servers ## Capabilities** - Allow for the discovery of **ALL** (new, old, experimental, public, internal, Gateway, non-Gateway, WMF, non-WMF) Wikimedia HTTP APIs through an API catalog -- [Deprioritized] Serve API reference documentation created using the to-be-developed API Platform documentation tooling - Act as a multilingual wiki for API-related learning materials, like tutorials and best practices - Create and manage Wikimedia OAuth 2.0 clients Define new content strategy for the API Portal.## Information architecture ### Overview - **/Learn**: code samples, tutorials, and topics that teach people how to use Wikimedia APIs - **/API catalog**: a list of available Wikimedia APIs, each with an API pages providing information about the API and links to docs - **/Community**: resources for connecting the API community and helping them share their work, including announcements, featured projects, and contributing instructions - **/API guidelines**: resources for API creators, including the API guidelines, process for adding an API, and other best practices ### /Learn The Learn section provides code samples, tutorials, and topics that teach people how to use Wikimedia APIs. This content is meant to be supplementary to API reference docs and primarily used by beginners and first-time users. Within the Learn section, editors can contribute code samples, tutorials, and topics using a set of standard templates. Pages under Learn have a flat structure. The Learn landing page includes the get started flow, a list of featured tutorials, related sets of pages, and ways to browse pages by tags. (The specific tagging system and mechanism are to be determined.) ### /API catalog The API catalog lets users browse a list of available Wikimedia APIs. To reflect the current state of Wikimedia APIs, each API in the catalog is considered a stand-alone API in terms of functionality and conventions. Each API in the catalog links to an API page. An API page is the home of an API; it acts as a central information hub and communication point between an API’s users and creators. The API page includes information about the API, commenting via the talk page, a link to the reference documentation, and links to relevant Learn pages. Subpages of the API page can be used for API reference documentation or for topics specific to that API. However, API reference documentation does not have to be stored in the API Portal. As long as the API reference meets the requirements for guaranteed accuracy (as set by the API guidelines), the docs can be stored anywhere and be discovered through the link on the API page. ## Content types - landing page - API page - topic - tutorial - code sample - process page - guideline ## Proposed structure and map to existing pages [Google Sheet](https://docs.google.com/spreadsheets/d/1u9XtdmuAOj5RQTL9tRVgnXD3TlZ_HdyU_DepVS8N8vM/edit#gid=0) (publicly viewable)