Page MenuHomePhabricator

Set up Dev Portal prototype to allow for experimentation
Closed, ResolvedPublic

Description

Andre has set up a great HTML prototype of the Dev Portal at people.wikimedia.org. The Dev Portal prototype will be our most important content strategy tool over the next few months, so I'd like to spend some time as a group thinking about our requirements for it and how we can maintain it going forward. This prototype will be purely for content development and user testing, so it doesn't need to be blocked by the technical investigation phase.

Requirements (WIP):

  • Can be modified by Andre, Alex, and Sarah R
  • Can be maintained through a code review process
  • Somewhat mimics the Dev Portal's final design by using Wikimedia styles and standard web components
  • Can be accessed publicly in a browser
  • Not too much initial effort to set up

Options to discuss (WIP):

  • people.wikimedia.org
    • According to Wikitech, this requires shell access in production to update?
  • Toolforge for hosting
  • GitHub for source control
  • a Vue site
    • Is this overkill for our needs? How much work would it be to set this up?
    • Possibility to leverage wvui
  • a VuePress static site
    • Something like this theme could work well for us
    • I think I remember Bryan saying that JavaScript wasn't a good fit for a static site :)
  • a Hugo static site
    • Example of a documentation theme
    • Hugo would be my top choice for a non-Vue static site generator

Event Timeline

@Aklapper, @srodlund, What do you think about these requirements and options? I did some experimenting with VuePress earlier this year, and it was pretty easy to get started.

apaskulin triaged this task as Medium priority.Jul 2 2021, 8:17 PM
apaskulin moved this task from Inbox to Content & design on the Wikimedia-Developer-Portal board.

After chatting with Andre, he doesn't have a strong preference, so I'm going to go ahead and set up an example

I've set up a Vuepress site on GitHub and GitHub Pages. The repo is at https://github.com/apaskulin/wmf-dev-portal-draft and the site is available at https://apaskulin.github.io/wmf-dev-portal-draft/. I decided against using Toolforge because this will be temporary, and I didn't want to use up resources only to have the tool deleted in a few months.

I've set up a reasonable build and deploy process for the site that Andre, Sarah, and I can use going forward.