Page MenuHomePhabricator

Finalize dev portal content and structure: "Use content or data" section
Closed, ResolvedPublic

Description

  • Review content and compare with on-wiki content to identify potential coverage gaps.
  • Interview and collaborate with SMEs in each area to identify key user tasks and potential gaps in portal content.
  • Update site structure and content, confirm correct sequencing for content on each page.
  • Complete task-completion-focused UXR (tracked in T286087 and related).
  • Review and finalize all copy.
  • Add any docs not already included in the Key Docs list to the schedule for doc review.
  • Resolve all TODOs in markdown files.

Notes

Proposed structure

  • Explore featured apps (app-galleries)
    • seealso.org
    • apps-gallery.toolforge.org
    • toolhub.wikimedia.org
    • wikidata.org/wiki/Wikidata:Tools/Visualize_data
  • Discover available wikis (content-overviews)
    • List of wikis
    • Browse by language (SiteMatrix)
    • About open licenses
  • Reuse wiki content (reuse-content)
    • Browse libraries by programming language (API/Client code)
    • Use the API (Action API)
    • Download content in bulk
    • Tutorials (tutorials-content)
      • Two featured tutorials
      • Link to tutorials page
  • Access public datasets (access-data)
    • Wikidata
    • Wikistats
    • Recent changes
    • Tutorials (tutorials-data)
      • Two featured tutorials
      • Link to tutorials page
  • Learn with tutorials (tutorials-reuse)
  • Enterprise (single link)

Strategy

  • Link to introductory content to help orient content reusers without prior experience with Wikimedia.
  • Link to tutorials to help content reusers who are new to programming.
  • To support users without prior Wikimedia experience, avoid using Wikimedia jargon. For example, “wiki” is more specific and more obvious than “project”.
  • There are several APIs that provide overlapping functionality for accessing wiki content. Instead of presenting a list of all available APIs, the Dev Portal should present the most stable, most complete APIs for the task. This includes not linking to APIs marked as experimental or unstable.
  • When linking to APIs, link to the API landing page; do not link to specific modules or endpoint groups within an API.
  • Separating read-only access (content reuse) and write access (tools and bots) allows us to partition off the complexity involved with editing to make things simpler for content reusers.
  • Present all content reuse tutorials on a dedicated page, and present a few featured tutorials on content and data subpages.
  • Content reuse journeys do not include hosting projects in Wikimedia Cloud Services.

High level user journey

  • Understand that Wikimedia content and data can be reused under open licenses
    • Choose a project, topic, or dataset
      • Choose a method of access
        • Test access
          • Set up attribution
            • Write the code
              • Publish
                • Share

Event Timeline

TBurmeister changed the task status from Open to In Progress.Jan 12 2022, 9:24 PM
TBurmeister triaged this task as Medium priority.
TBurmeister changed the task status from In Progress to Open.Jan 19 2022, 5:17 PM
TBurmeister reassigned this task from TBurmeister to apaskulin.

Spreadsheet cleaning notes for content coverage: portal doesn't currently link to the following docs that were included in previous iterations or lists:

Here are the user journeys and key docs we identified as focal points for the Dev Portal related to Wikibase and Wikidata content:

I don't remember how e.g. https://meta.wikimedia.org/wiki/Special:MyLanguage/Research:Data ended up in this, or strange pages like https://www.mediawiki.org/wiki/API:Page_info_in_search_results

Some of these links came from building out the dev portal current iteration. We had identified that something like "accessing wiki data" was a user journey that was important to cover, but the original list of key docs didn't include resources to fully address information needs as part of that journey. What we are doing now is reconciling the things I added with the previously-identified lists of important docs, so we are sure to be covering the content that is essential to each of the user journeys covered by the portal.

Change 774550 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[wikimedia/developer-portal@main] content: Update content reuse section

https://gerrit.wikimedia.org/r/774550

Change 774550 merged by jenkins-bot:

[wikimedia/developer-portal@main] content: Update content reuse section

https://gerrit.wikimedia.org/r/774550

Change 777895 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[wikimedia/developer-portal@main] content: Add data landing page

https://gerrit.wikimedia.org/r/777895

Change 777895 merged by jenkins-bot:

[wikimedia/developer-portal@main] content: Add data landing page

https://gerrit.wikimedia.org/r/777895

Change 778592 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[wikimedia/developer-portal@main] content: Update link

https://gerrit.wikimedia.org/r/778592

Change 778592 merged by Alex Paskulin:

[wikimedia/developer-portal@main] content: Update link

https://gerrit.wikimedia.org/r/778592