Difference between revisions of "Resources"

From Wikidocumentaries
Jump to navigation Jump to search
(→‎Communication & community)
 
(74 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
== Communication & community ==
+
==Cheat sheet for important actions==
  
−
* '''[http://blog.wikidocumentaries.io/ Wikidocumentaries blog]''' The blog features articles about activities created around Wikidocumentaries. Articles can be published in Finnish and English.
+
=== Updating wikidocumentaries-demo.wmflabs.org code from GitHub ===
−
* '''[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.
 
  
−
== Developer resources ==
+
# Login with SSH to the hupu server:
 +
#: <code>ssh hupu.eqiad.wmflabs</code>
 +
# Run:
 +
#: <code>sudo -s</code>
 +
# Run:
 +
#: <code>sudo -s -u wikidocumentaries-web</code>
 +
# Run:
 +
#: <code>script /dev/null</code>
 +
# To see detached screens (there should be two, one for wikidocumentaries-ui and one for the wikidocumentaries-topic-search-api), run:
 +
#: <code>screen -ls</code>
 +
# Restore a screen (replace the last parameter with the actual screen id), e.g. run:
 +
#: <code>screen -r 24566.pts-4.hupu</code>
 +
# Stop the running node ui/api app, press:
 +
#: <code>ctrl+c</code>
 +
# Pull changes from the GitHub (and if needed resolve conflicts), run:
 +
#: <code>git pull origin master</code>
 +
# Start the node ui/api app again, run:
 +
#: <code>npm run dev</code>
 +
# Exit from the screen, press:
 +
#: <code>ctrl+a+d</code>
 +
# Restore the other screen and update the app following again from the step 6 to the step 11
 +
# Exit the script and then from the wikidocumentaries-web shell and root shell, press:
 +
#: <code>ctrl+d</code> and again <code>ctrl+d</code> and again <code>ctrl+d</code>
 +
# You have succesfully updated the wikidocumentaries-ui/wikidocumentaries-topic-search-api and may now logout from the hupu server
  
−
===Wikidocumentaries===
+
===Adding users to the Wikidocumentaries project on Hupu===
−
* Wikidocumentaries Github repository
 
−
* [https://phabricator.wikimedia.org/tag/wikidocumentaries/ Wikidocumentaries Phabricator project]
 
  
−
===Wikimedia Tech===
+
# Sign in on page https://horizon.wikimedia.org
 +
# In the dropdown next to the left top logo choose ''Wikidocumentaries''
 +
# In the left dropdown choose ''Project'' -> ''Access'' -> ''Project Members''
 +
# Press button + ''Add members'' on the right
 +
# Fill in either ''User name'' or ''Shell name'' (one is enough) and choose ''Project Admin'' to grant all privileges
  
−
===Wikibase and Wikidata===
+
== Wikimedia developer resources ==
  
−
===Front end===
+
===MediaWiki===
−
* Vue.js
+
* MediaWiki homepage https://www.mediawiki.org/wiki/MediaWiki
−
* Leaflet
+
* MediaWiki Vagrant portable MediaWiki development environment https://www.mediawiki.org/wiki/MediaWiki-Vagrant
−
* OpenLayers
+
 
 +
===Wikibase===
 +
* https://github.com/wmde/wikibase-docker
 +
* 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
 +
 
 +
=== LAMP stack ===
 +
 
 +
==Front end==
 +
===Vue.js===
 +
 
 +
Current (17.10.2018) Wikidocumentaries UI is built with Vue.js
 +
 
 +
* '''[https://vuejs.org/v2/guide/ Vue.js official guides]'''
 +
* [https://www.shopify.com/partners/blog/vuejs-tutorial Vue.js tutorial with the Webpack]
 +
* [https://github.com/vuejs-templates/webpack Vue.js Webpack] starter pack
 +
 
 +
==Component-specific==
 +
 
 +
===Parsing Wiki content===
 +
 
 +
====Cheerio====
 +
* https://github.com/cheeriojs/cheerio
 +
 
 +
===Surveyor geotagging tool===
 +
* [http://spacetime.nypl.org/surveyor/#/510d47d9-4fa3-a3d9-e040-e00a18064a99 Surveyor at New York Public Library]
 +
* [https://github.com/nypl-spacetime/surveyor Surveyor GitHub repository]
 +
* [http://spacetime.nypl.org/Leaflet.GeotagPhoto/ Leaflet.GeoTagPhoto plugin]
 +
* [https://github.com/nypl-spacetime/brick-by-brick brick-by-brick JSON API]
 +
 
 +
==== React ====
 +
Current (17.10.2018) Surveyor UI is built with React
 +
 
 +
* [https://reactjs.org/docs/getting-started.html Official React Getting Started guide]
 +
 
 +
==== Vue.js and React together ====
 +
*https://x-team.com/blog/react-vue-component-integration/
 +
*[https://github.com/akxcv/vuera vuera] - Vue in React, React in Vue
 +
 
 +
==== Leaflet ====
 +
* [https://leafletjs.com/examples.html Official Leaflet Tutorials]
 +
 
 +
===Map component===
 +
 
 +
====OpenLayers====
 +
 
 +
* [https://openlayers.org/en/latest/doc/quickstart.html Official OpenLayers Quick Start]
 +
* [https://openlayers.org/en/latest/examples/ Official OpenLayers Examples]
 +
* [http://openlayers.org/en/latest/apidoc/ Official OpenLayers API Docs]
  
 
{{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

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

Retrieved from "https://wikidocumentaries.wmcloud.org/w/index.php?title=Resources&oldid=21116"