Resources

Communication & community

General communication

• Wikidocumentaries blog The blog features articles about activities created around Wikidocumentaries. Articles can be published in Finnish and English.
• Wikidocumentaries Facebook group. The group is primarily for informing about future events and promoting related events. Events can be multilingual, currently in Finland primarily.
• Wikidocumentaries Slack channel The network of project partners preparing events and funding applications collaboratively.

Wikidocumentaries for developers

• Wikidocumentaries Github repository
• Wikidocumentaries Phabricator project

Cheat sheet for important actions

Wikimedia and project accounts

1. Get a Wikimedia account (the same account for all Wikipedias, Wikimedia Commons, Wikidata etc.) e.g. https://www.wikidata.org/wiki/Special:UserLogin
2. Get the Wikimedia developer account > Registration instructions under "VPS and General Users". The same key and password let you access The Wikimedia Cloud Services at https://wikitech.wikimedia.org and the git repositories located at https://gerrit.wikimedia.org/. You are also creating a separate Shell account. Read also:
   • https://wikitech.wikimedia.org/wiki/Main_Page
   • https://wikitech.wikimedia.org/wiki/Help:Access
3. Create an account in Wikimedia Phabricator
4. Ask to join the codebase in GitHub
5. Ask for an account to edit this wiki

Updating wikidocumentaries-demo.wmflabs.org code from GitHub

1. Login with SSH to the hupu server:

   ssh hupu.eqiad.wmflabs

2. Run:

   sudo -s

3. Run:

   sudo -s -u wikidocumentaries-web

4. Run:

   script /dev/null

5. To see detached screens (there should be two, one for wikidocumentaries-ui and one for the wikidocumentaries-topic-search-api), run:

   screen -ls

6. Restore a screen (replace the last parameter with the actual screen id), e.g. run:

   screen -r 24566.pts-4.hupu

7. Stop the running node ui/api app, press:

   ctrl+c

8. Pull changes from the GitHub (and if needed resolve conflicts), run:

   git pull origin master

9. Start the node ui/api app again, run:

   npm run dev

10. Exit from the screen, press:

    ctrl+a+d

11. Restore the other screen and update the app following again from the step 6 to the step 11
12. Exit the script and then from the wikidocumentaries-web shell and root shell, press:

    ctrl+d and again ctrl+d and again ctrl+d

13. You have succesfully updated the wikidocumentaries-ui/wikidocumentaries-topic-search-api and may now logout from the hupu server

Adding users to the Wikidocumentaries project on Hupu

1. Sign in on page https://horizon.wikimedia.org
2. In the dropdown next to the left top logo choose Wikidocumentaries
3. In the left dropdown choose Project -> Access -> Project Members
4. Press button + Add members on the right
5. Fill in either User name or Shell name (one is enough) and choose Project Admin to grant all privileges

Wikimedia developer resources

MediaWiki

• The Wikibase setup including MediaWiki, Wikibase and the SPARQL endpoint are included in a Docker compose at https://github.com/wmde/wikibase-docker/blob/master/README-compose.md
• MediaWiki homepage https://www.mediawiki.org/wiki/MediaWiki
• MediaWiki Vagrant portable MediaWiki development environment https://www.mediawiki.org/wiki/MediaWiki-Vagrant

Front end

Vue.js

Current (17.10.2018) Wikidocumentaries UI is built with Vue.js

• Vue.js official guides
• Vue.js tutorial with the Webpack
• Vue.js Webpack starter pack

Component-specific

Parsing Wiki content

Cheerio

• https://github.com/cheeriojs/cheerio

Surveyor geotagging tool

• Surveyor at New York Public Library
• Surveyor GitHub repository
• Leaflet.GeoTagPhoto plugin
• brick-by-brick JSON API

React

Current (17.10.2018) Surveyor UI is built with React

• Official React Getting Started guide

Vue.js and React together

• https://x-team.com/blog/react-vue-component-integration/
• vuera - Vue in React, React in Vue

Leaflet

• Official Leaflet Tutorials

Map component

OpenLayers

• Official OpenLayers Quick Start
• Official OpenLayers Examples
• Official OpenLayers API Docs

API documentations

Wikimedia

MediaWiki API

• https://www.mediawiki.org/wiki/API:Tutorial
• https://en.wikipedia.org/w/api.php Wikipedia API help

Wikidata

• Wikidata Query Service - SPARQL
• Wikidata API help - MediaWiki API

Wikimedia Commons

• Wikimedia Commons API help - MediaWiki API

Media services

Finna.fi

• Finna API documentation
• Old but still somewhat useful Finna API documentation

Flickr

• Flick API Docs - Includes useful API Explorer

Ajapaik

Ajapaik.ee

Linked Data Finland

• BiographySampo
• SotaSampo

Map services

Map Warper

• Map Warper API documentation

Design files

• https://www.figma.com/files/project/891845/Wikidocumentaries

Misc.

Images

• For the federated API query to be able to search
  • Name of the topic, time, location as coordinates or address, existing authority IDs (Eg YSO), alternative names, language variants...

Digitized maps

• Date
• Historical administrative entities
• Source
• Stack Overflow - Developer Community Q&A & knowledge sharing

Navigation

About	Technology	Design	Content modules	Tool pages	Projects
Status Wikidocumentaries blog Wikidocumentaries demo Phabricator project Facebook group GitHub repository Translation in TranslateWiki Wikidocumentaries Slack	Setting up dev environment Resources Translations Languages Using Wikibase Federation with Wikidata APIs Linking Media metadata Properties to content User registration Licensing	Page types Landing page Search page Topic page User page Organisation page Project page Tool page Tasks Components Main toolbar and footer Search Faceting Topic page header Content module Dropdown Modal Icons	Active modules Article Family tree Gallery Historical map Images Image viewer Infobox Map Module ideas Audio/Video Bibliography Correspondence Discussion Graph Name Newspaper articles Testimonials Timeline Visualizations Wikidocumentary 3D	Visual editor Query tool QuickStatements Open Refine Creating topics Uploading images Geolocating tool Metadata editor Rectifying maps Transcription Annotation tool	Central Park Archives Convent Quarter Wikisource