Difference between revisions of "Resources"

From Wikidocumentaries
Jump to navigation Jump to search
(API documentations)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Communication & community ==
 
 
===General communication===
 
 
* '''[http://blog.wikidocumentaries.io/ Wikidocumentaries blog]''' The blog features articles about activities created around Wikidocumentaries. Articles can be published in Finnish and English.
 
* '''[https://www.facebook.com/groups/wikidocumentaries/ Wikidocumentaries Facebook group]'''. The group is primarily for informing about future events and promoting related events. Events can be multilingual, currently in Finland primarily.
 
* '''[https://wikidocumentaries.slack.com/ Wikidocumentaries Slack channel]''' The network of project partners preparing events and funding applications collaboratively.
 
 
===Wikidocumentaries for developers===
 
* '''[https://github.com/Wikidocumentaries Wikidocumentaries Github repository]'''
 
* '''[https://phabricator.wikimedia.org/tag/wikidocumentaries/ Wikidocumentaries Phabricator project]'''
 
 
 
==Cheat sheet for important actions==
 
==Cheat sheet for important actions==
  
Line 49: Line 37:
  
 
== Wikimedia developer resources ==
 
== Wikimedia developer resources ==
 
=== LAMP stack ===
 
  
 
===MediaWiki===
 
===MediaWiki===
* https://www.mediawiki.org/wiki/MediaWiki
+
* MediaWiki homepage https://www.mediawiki.org/wiki/MediaWiki
 +
* MediaWiki Vagrant portable MediaWiki development environment https://www.mediawiki.org/wiki/MediaWiki-Vagrant
  
===Wikimedia Cloud Services===
+
===Wikibase===
# Get a '''Wikimedia account''' (the same account for all Wikipedias, Wikimedia Commons, Wikidata etc.)
+
* https://github.com/wmde/wikibase-docker
# Get the '''Wikimedia developer account'''. 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/.
+
* 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
# Create an account in Wikimedia Phabricator
 
https://wikitech.wikimedia.org/wiki/Main_Page
 
  
https://wikitech.wikimedia.org/wiki/Help:Access
+
=== LAMP stack ===
  
 
==Front end==
 
==Front end==
Line 72: Line 57:
 
* [https://github.com/vuejs-templates/webpack Vue.js Webpack] starter pack
 
* [https://github.com/vuejs-templates/webpack Vue.js Webpack] starter pack
  
===Cheerio===
+
==Component-specific==
 +
 
 +
===Parsing Wiki content===
 +
 
 +
====Cheerio====
 
* https://github.com/cheeriojs/cheerio
 
* https://github.com/cheeriojs/cheerio
 
==Project-specific==
 
  
 
===Surveyor geotagging tool===
 
===Surveyor geotagging tool===
Line 83: Line 70:
 
* [https://github.com/nypl-spacetime/brick-by-brick brick-by-brick JSON API]
 
* [https://github.com/nypl-spacetime/brick-by-brick brick-by-brick JSON API]
  
=== React ===
+
==== React ====
 
 
 
Current (17.10.2018) Surveyor UI is built with React
 
Current (17.10.2018) Surveyor UI is built with React
  
 
* [https://reactjs.org/docs/getting-started.html Official React Getting Started guide]
 
* [https://reactjs.org/docs/getting-started.html Official React Getting Started guide]
  
=== Vue.js and React together ===
+
==== Vue.js and React together ====
 
 
 
*https://x-team.com/blog/react-vue-component-integration/
 
*https://x-team.com/blog/react-vue-component-integration/
 
*[https://github.com/akxcv/vuera vuera] - Vue in React, React in Vue
 
*[https://github.com/akxcv/vuera vuera] - Vue in React, React in Vue
  
=== Leaflet ===
+
==== Leaflet ====
 +
* [https://leafletjs.com/examples.html Official Leaflet Tutorials]
  
* [https://leafletjs.com/examples.html Official Leaflet Tutorials]
+
===Map component===
  
===OpenLayers===
+
====OpenLayers====
  
 
* [https://openlayers.org/en/latest/doc/quickstart.html Official OpenLayers Quick Start]
 
* [https://openlayers.org/en/latest/doc/quickstart.html Official OpenLayers Quick Start]
 
* [https://openlayers.org/en/latest/examples/ Official OpenLayers Examples]
 
* [https://openlayers.org/en/latest/examples/ Official OpenLayers Examples]
 
* [http://openlayers.org/en/latest/apidoc/ Official OpenLayers API Docs]
 
* [http://openlayers.org/en/latest/apidoc/ 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====
 
* [https://query.wikidata.org/ Wikidata Query Service] - SPARQL
 
* [https://www.wikidata.org/w/api.php Wikidata API help] - MediaWiki API
 
 
====Wikimedia Commons====
 
 
*[https://commons.wikimedia.org/w/api.php Wikimedia Commons API help] - MediaWiki API
 
 
===Media services===
 
 
==== Finna.fi ====
 
* [https://api.finna.fi/swagger-ui/?url=%2Fapi%2Fv1%3Fswagger Finna API documentation]
 
* [https://www.kiwi.fi/display/Finna/Finnan+avoin+rajapinta Old but still somewhat useful Finna API documentation]
 
 
==== Flickr ====
 
 
*[https://www.flickr.com/services/api/ Flick API Docs] - Includes useful API Explorer
 
 
==== Internet Archive ====
 
 
==== Nimiarkisto.fi ====
 
 
==== Ajapaik ====
 
[https://ajapaik.ee Ajapaik.ee]
 
 
==== Linked Data Finland ====
 
* BiographySampo
 
* SotaSampo
 
 
==== FIN-CLARIN ====
 
 
====Topothek====
 
 
==API documentations for map services ==
 
 
=== Map Warper ===
 
 
*[https://github.com/timwaters/mapwarper/blob/master/README_API.md 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
 
* [https://stackoverflow.com/ Stack Overflow] - Developer Community Q&A & knowledge sharing
 
  
 
{{design-nav}}
 
{{design-nav}}

Latest revision as of 13:50, 6 December 2019

Cheat sheet for important actions

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

Wikibase

LAMP stack

Front end

Vue.js

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

Component-specific

Parsing Wiki content

Cheerio

Surveyor geotagging tool

React

Current (17.10.2018) Surveyor UI is built with React

Vue.js and React together

Leaflet

Map component

OpenLayers


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

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