You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Developer Portal: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Aklapper
(Add a "Contribute" section. See phab:T306832.)
imported>Aklapper
Line 296: Line 296:
=== Translate content to your language ===
=== Translate content to your language ===


'''TODO:''' This depends on [[phab:T308236]], [[phab:T290256]]. If there are specific caveats found in [[phab:T303987]], link from here to information. Translation link will probably be something like https://translatewiki.net/w/i.php?title=Special:Translate&group=wikimedia-developer-portal
Please translate content at https://translatewiki.net/wiki/Translating:WikimediaDeveloperPortal
 
Your translations will be regularly merged into the codebase at https://gerrit.wikimedia.org/g/wikimedia/developer-portal/. After a while, the latest codebase will be deployed on https://developer.wikimedia.org/ and translations become available to anyone visiting the website.

Revision as of 06:51, 18 May 2022


The Developer Portal is a central entry point for Wikimedia technical documentation. The portal is a static site built using MkDocs and Material for MkDocs. It uses a custom plugin to generate PO files and integrate with translatewiki.net. For more information about the project, see mw:Developer Advocacy/Developer Portal.

View the demo Browse the repository

How it works

Rendering page content

The purpose of the Developer Portal is to help users find key documentation pages. The site is designed to make it easy to remix documentation links into new pages tailored for different purposes. Data in the Dev Portal is organized into three main types of data:

documents
YAML files in data/documents describe key documents. Each document can be assigned to one or more categories.
categories
YAML files in data/categories describe categories. Behind the scenes, our macros/__init__.py local plugin collects categories and their corresponding documents into data that can be used in jinja templates.
markdown files
Markdown files reside in src/ subdirectories which correspond to the top-level sections of the dev portal site. Jinja template syntax inside those markdown files pulls in content from categories and documents.

Rendering the navigation

The Material theme for Mkdocs generates navigation sections based on the documents in a given subdirectory. It renders tables of contents based on the structure of an individual markdown file (its headings).

The navigation.indexes setting in mkdocs.yml implements section index pages. This causes the index.md file for a directory to be used as the landing page for a section. We use this feature because our index.md files (in /src) only include links to the other pages in the directory, so we don't need or want them to be displayed as an additional item to click in the left nav.

While it could be simpler to use a single markdown file for each site section, and rely on the TOC for navigation, this has drawbacks:

  • The TOC disappears on small screens, effectively removing navigation to key subsections.
  • Using multiple markdown files enables navigation through and between site sections via buttons at the bottom of the screen. This is a nice additional navigation option to supplement the left and/or horizontal menus.
  • Using a single index.md file populated via YAML for each site section means that nearly all the site structure will be rendered via YAML and templates. This means a larger number of YAML files, and a more difficult structure to understand if you're encountering the site for the first time. It's easier to understand how the site is rendered -- and thus better for future maintainers -- when more of the structure is coming from markdown and less from YAML and Jinja magic.

For more details about why we made these implementation decisions, see this Miro board (restricted access).

How to use it

The Material theme for Mkdocs renders content in ways that can be confusing due to our usage of templates to generate page content based on yaml docs and categories (see the /data subdirectory).

This section describes the content requirements that doc editors and creators must follow in order for the site to render correctly and consistently.

Hide TOC in subdirectory index files

index.md files in subdirectories of the /src directory must hide the table of contents. This is necessary because the content of most of these pages is navigational: the section headers in the page mirror the list of other pages in the directory/navigation section, so the navigation and the table of contents render the same content. This is only true for subdirectories of the /src directory–not for the top-level index.md nor for any other markdown files.

To hide the table of contents, include the following at the top of the index.md file:

---
hide:
  - toc
---

Mirror text copy in index files and category files

In general (but not always), each section (##) in a subdirectory index.md file should contain:

  • A text snippet that is the same as the category description used in the Jinja template on the subpage to which that section links
  • A link to another md file (subpage) in that directory

Render a document

To render a single document, add this syntax to a markdown file:

{{ document.render( "document-filename-here" ) }}

This renders the document with an h2 heading. To customize the heading level, add the level as an argument.

For example, this syntax renders a document with an h3 heading:

{{ document.render( "document-filename-here", 3 ) }}

Render a category

To render a category and its assigned documents, add this syntax to a markdown file.

Render one category per page:

{{ category.render( "category-name-here" ) }}

Render multiple categories per page:

{{ category.render( "category-name-here", 2 ) }}

Order documents in a category

To control the order that documents appear in a category, use this syntax in the document YAML definition:

categories:
    category-a: 1
    category-b: 2
    category-c: 0

In this example, the document will be ordered first in category-a, second in category-b, and unordered in category-c. Note that if a document needs to be ordered in any of its category, all listed categories must use the dictionary syntax instead of the list syntax (category-a: 1 instead of - category-a).

If a category contains both ordered and unordered documents, the unordered documents are listed first since their index is 0.

Content conventions

  • In most cases, documentation links should link to the top of the page, not to a specific section. Exceptions include linking to specific endpoints or endpoint groups in an OpenAPI specification or in cases where it is not possible to break up a long page.
  • All documentation links should be stored in data/documents, not in markdown files, with the exception of the intro on the site homepage.

Mkdocs plugins

Macros module

The upstream macros plugin adds support for jinja templates to the markdown pages of a MkDocs website. We extend this plugin using a custom "macros" Python module. This exposes various variables and macros to the jinja layer.

Variables

categories
Dict of keyed by category name of information loaded from YAML files found in data/categories. In addition to the data found by parsing the YAML file, each value contains a "documents" list which includes every document from data/documents which was tagged with the category.
documents
Dict keyed by file name (minus extension) of document information loaded from YAML files found in data/documents.

Macros

category_data( name )
Get the data for a category or an empty dict if the category does not exist.
document_data( name )
Get the data for a document or an empty dict if the document does not exist.

JinjaWrapperPlugin

Wrap markdown files in a jinja template.

This plugin works in concert with the macros plugin to setup each markdown file as an extension of the data/includes/markdown_base.jinja template prior to it being rendered by the macros plugin. This in turn allows us to setup common imports and macros for use by all markdown files while keeping boilerplate in the markdown files themselves to a minimum.

TranslatePlugin

Translate content via Gnutext PO files.

This local MkDocs plugin maintains a translation catalog based on English language content extracted from the src/**/*.md Markdown documents and other configuration files as a GNU Portable Object (PO) file suitable for import by translatewiki.net. It also generates internationalized static pages based on non-English PO files found in subdirectories of data/locale/. Translation units are extracted from Markdown documents after the Jinja templates are expanded.

This plugin was heavily inspired by both mkdocs-mdpo-plugin and mkdocs-static-i18n which attempt to provide similar functionality.

The plugin hooks into a number of lifecycle events exposed by MkDocs:

on_config
on_files
  • Extract translation units from English mkdocs.yml config values
  • Create a parallel content tree in the tmp dir for each target language for translation
on_nav
  • If target language is English, extract translation units from nav config
  • If target language is non-English, translate non-English nav config
on_page_markdown
  • If target language is non-English, translate Markdown using PO data
  • If target language is English, extract translation units from Markdown
on_page_context
  • Update alternate links to point to current page in other locales
on_post_build
  • For each supported locale, build translated pages using a truncated version of the MkDocs internal build process
  • Remove obsolete translation units from English PO file
  • Remove generated tmp directory and contents
on_build_error
  • Remove generated tmp directory and contents

Local development environment

Quick start

$ git clone https://gerrit.wikimedia.org/r/wikimedia/developer-portal
$ cd developer-portal
$ make start
$ open http://127.0.0.1:9000/

$ vim src/index.md
$ make build
$ open http://127.0.0.1:9000/

How it works

The local development environment uses docker-compose and GNU Make to manage a container hosting the project. This container is used to build and serve the compiled mkdocs project.

Demo server

A demo server is available at https://developer-portal.wmcloud.org/. This proxy points to an instance in the "devportal" Cloud VPS project which uses Podman to run the latest developer portal container as built by PipelineLib. A systemd timer runs podman auto-update every 5 minutes to poll for newer container versions.

The demo server was manually built and does not currently have any Puppet automation to build a new instance. The manual work needed however is a relatively small amount of effort thanks to the magic of podman:

$ sudo apt install podman
$ sudo podman pull docker-registry.wikimedia.org/wikimedia/wikimedia-developer-portal:latest
$ sudo podman run --name developer-portal --label 'io.containers.autoupdate=image' --rm --detach --publish 0.0.0.0:8000:8000 docker-registry.wikimedia.org/wikimedia/wikimedia-developer-portal:latest
$ sudo podman generate systemd --new --name developer-portal | sudo tee /etc/systemd/system/developer-portal.service
$ sudo systemctl enable developer-portal
$ sudo systemctl start developer-portal
$ sudo systemctl edit podman-auto-update.timer # Set to run every 5m
$ sudo systemctl enable podman-auto-update.service
$ sudo systemctl start podman-auto-update.service

Troubleshooting

AttributeError: 'NoneType' object has no attribute 'items'

  • Check for a Markdown file with an empty link. (You can search the /src directory for ]().) In the Dev Portal, links in Markdown must have a value for the URL.
Yes
[link text](placeholder)
No
[link text]()
  • Check for a document file with an empty categories list. If a document has no categories, the categories line should be removed.
Yes
---
title: My title
description: My description
links:
  - url: https://...
    label: Learn more
categories:
  - example-category
---
title: My title
description: My description
links:
  - url: https://...
    label: Learn more
No
--
title: My title
description: My description
links:
  - url: https://...
    label: Learn more
categories:
# no categories

TypeError: unhashable type: 'dict'

  • Check YAML syntax for files in which you're attempting to Order documents in a category. If you're adding an order argument to the category field, you must not prefix the category name with a hyphen:


Yes
---
title: Hackathons
description: A hackathon brings together people with different skills to work together on a common technical goal.
links:
  - url: https://www.mediawiki.org/wiki/Special:MyLanguage/Hackathons
    label: Read more on mediawiki.org
categories:
  events: 1
No
---
title: Hackathons
description: A hackathon brings together people with different skills to work together on a common technical goal.
links:
  - url: https://www.mediawiki.org/wiki/Special:MyLanguage/Hackathons
    label: Read more on mediawiki.org
categories:
  - events: 1 # hyphen in this line must be removed

Contribute

Propose content changes

Please propose content additions or content changes in a Phabricator task. (Learn more about Phabricator.)

We would like to keep content on the portal limited. Pages should not duplicate other pages. Pages must be high quality and helpful. Please be aware of the user journeys. Pages which are proposed to be linked must follow the documentation guide for accuracy and consistency.

The proposed changes will be reviewed by the Developer Advocacy team.

Textual content is licensed under CC-BY-SA 3.0.

Propose code changes

Please propose code changes to the developer portal code base itself in a Phabricator task. (Learn more about Phabricator.)

The codebase is located at https://gerrit.wikimedia.org/g/wikimedia/developer-portal/. To prepare a code change yourself, set up your #Local development environment and provide a changeset in a Gerrit branch following the commit message guidelines.

The proposed changes will be reviewed by the Developer Advocacy team.

Code is licensed under GNU GPL version 3 or later.

Translate content to your language

Please translate content at https://translatewiki.net/wiki/Translating:WikimediaDeveloperPortal

Your translations will be regularly merged into the codebase at https://gerrit.wikimedia.org/g/wikimedia/developer-portal/. After a while, the latest codebase will be deployed on https://developer.wikimedia.org/ and translations become available to anyone visiting the website.