User:Mooeypoo/VisualEditor Development

ssh://<username>@gerrit.wikimedia.org:29418

$ apt-get install git

$ git config --global user.name "Your Name Here"
$ git config --global user.email "your_email@example.com 

$ git config --global color.ui true

$ cd ~/.ssh
# List the files in your .ssh directory:
$ ls# Create a new ssh key, using the provided email as a label
$ ssh-keygen -t rsa -C "your_email@example.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/home/you/.ssh/id_rsa):
# Add the key in the system
$ ssh-add id_rsa

$ sudo apt-get install xclip
# Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`)
$ xclip -sel clip < ~/.ssh/id_rsa.pub
# Copies the contents of the id_rsa.pub file to your clipboard

$ sudo apt-get install python-pip
$ sudo easy_install pip
$ sudo pip install git-review

$ git config --global --add gitreview.username "gerritusername"

sudo apt-get install python-setuptools

$ git clone ssh://<username>@gerrit.wikimedia.org:29418/mediawiki/core.git <folder name>

$ git review -s

$ sudo apt-get install apache2
$ sudo apt-get install mysql-server php5-mysql
$ sudo mysql_install_db
$ sudo apt-get install php5 libapache2-mod-php5 php5-mcrypt php5-curl php5-intl php5-gd

$ ln -s <path to your mediawiki folder> /var/www/<symbolic name>

sudo apt install dirmngr
sudo apt-key advanced --keyserver keys.gnupg.net --recv-keys AF380A3036A03444

sudo apt-key advanced --keyserver pgp.mit.edu --recv-keys AF380A3036A03444

sudo apt-key advanced --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys AF380A3036A03444

sudo apt-add-repository "deb https://releases.wikimedia.org/debian jessie-mediawiki main"

sudo apt-get install software-properties-common

echo "deb https://releases.wikimedia.org/debian jessie-mediawiki main" | sudo tee /etc/apt/sources.list.d/parsoid.list

sudo apt install apt-transport-https
sudo apt update && sudo apt install parsoid

Error loading data from server: internal_api_error_Exception: [0db2f13b5ceecfae5a4c1a98] Exception caught: PHP cURL extension missing. Check https://www.mediawiki.org/wiki/Manual:CURL. Would you like to retry?

apt install php-curl
systemctl reload apache2

dnf install git npm make python2 gcc-c++ -y
cd /opt
git clone --recursive https://gerrit.wikimedia.org/r/mediawiki/services/parsoid/deploy
git clone https://gerrit.wikimedia.org/r/mediawiki/services/parsoid
cd parsoid
PYTHON=python2 npm install
cp config.example.yaml config.yaml
chown apache:apache /opt/parsoid

# /etc/systemd/system/parsoid.service
[Unit]
Description=Mediawiki Parsoid web service on node.js
Documentation=http://www.mediawiki.org/wiki/Parsoid
Wants=local-fs.target network-online.target
After=local-fs.target network-online.target

[Install]
WantedBy=multi-user.target

[Service]
Type=simple
User=apache
Group=apache
WorkingDirectory=/opt/parsoid
ExecStart=/usr/bin/node /opt/parsoid/bin/server.js
KillMode=process
Restart=on-failure
PrivateTmp=true
StandardOutput=syslog

<?xml version="1.0" encoding="utf-8"?>
<service>
  <short>Parsoid</short>
  <description>Wikitext converter for Mediawiki</description>
  <port protocol="tcp" port="8000"/>
</service>

firewall-cmd --reload
firewall-cmd --add-service=parsoid --permanent
firewall-cmd --reload

systemctl enable parsoid --now
curl http://localhost:8000

npm install --global --production windows-build-tools

npm -g install npm@latest

cd $env:userprofile

npm install parsoid

npm init

%USERPROFILE%\node_modules\parsoid\

copy %USERPROFILE%\node_modules\parsoid\localsettings.example.js %USERPROFILE%\node_modules\parsoid\localsettings.js

copy %USERPROFILE%\node_modules\parsoid\config.example.yaml %USERPROFILE%\node_modules\parsoid\config.yaml

C:\Users\USERNAME\node_modules\parsoid>node bin/server.js

cd %APPDATA%\npm\node_modules\parsoid
node bin/server.js

# For MediaWiki <= 1.30
docker run -d -p 8080:8000 -e PARSOID_DOMAIN_localhost=http://localhost/w/api.php thenets/parsoid:0.8

# For MediaWiki >= 1.31 & <= 1.32
docker run -d -p 8080:8000 -e PARSOID_DOMAIN_localhost=http://localhost/w/api.php thenets/parsoid:0.10

# For MediaWiki >= 1.33
docker run -d -p 8080:8000 -e PARSOID_DOMAIN_localhost=http://localhost/w/api.php thenets/parsoid:0.11

docker run -d -p 8080:8000 \
            -e PARSOID_DOMAIN_foobar=http://foobar.com/w/api.php \
            -e PARSOID_DOMAIN_example=http://example.com/w/api.php \
            -e PARSOID_DOMAIN_localhost=http://localhost/w/api.php \
            thenets/parsoid:0.11

# Expose port 8081
docker run -d -p 8081:8000 -e PARSOID_DOMAIN_localhost=http://localhost/w/api.php thenets/parsoid:0.11

# Expose port 8142
docker run -d -p 8142:8000 -e PARSOID_DOMAIN_localhost=http://localhost/w/api.php thenets/parsoid:0.11

services:
  - module: lib/index.js
    entrypoint: apiServiceWorker
    conf:
        mwApis:
          # This is the only required parameter,
          # the URL of you MediaWiki API endpoint.
        - uri: 'http://yoursite.com/w/api.php'
          # The "domain" is used for communication with Visual Editor
          # and RESTBase.  It defaults to the hostname portion of
          # the `uri` property above, but you can manually set it
          # to an arbitrary string.
          domain: 'yoursite.com'  # optional

metrics:
    type: log

services:
  - module: lib/index.js
    entrypoint: apiServiceWorker
    conf:
        # For backwards compatibility, and to continue to support non-static
        # configs for the time being, optionally provide a path to a
        # localsettings.js file.  See localsettings.example.js
        localsettings: ./localsettings.js

        #mwApis:
        #- # This is the only required parameter,
          # the URL of you MediaWiki API endpoint.
          #uri: 'http://localhost/w/api.php'
          # The "domain" is used for communication with Visual Editor
          # and RESTBase.  It defaults to the hostname portion of
          # the `uri` property below, but you can manually set it
          # to an arbitrary string.
          #domain: 'localhost'  # optional

parsoidConfig.setMwApi({ uri: 'http://yoursite.com/w/api.php', domain: 'yoursite.com', prefix: 'myspecialwiki' });

services:
  - module: lib/index.js
    entrypoint: apiServiceWorker
    conf:
        mwApis:
        - # First wiki
          uri: 'http://yoursite.com/w/api.php'
          domain: 'yoursite.com'  # optional
        - # If you have another wiki on a different domain
          uri: 'http://yourothersite.com/w/api.php'
          domain: 'yourothersite.com'  # optional
        - # If you have another wiki on the same domain
          uri: 'http://yoursite.com/w2/api.php'
          domain: 'wiki2'  # optional

parsoidConfig.setMwApi({ uri: 'http://yoursite.com/w/api.php', domain: 'yoursite.com', prefix: 'myspecialwiki' });
// If you have another wiki on a different domain:
parsoidConfig.setMwApi({ uri: 'http://yourothersite.com/w/api.php', domain: 'yourothersite.com', prefix: 'myotherspecialwiki' });
// If you have another wiki on the same domain:
// Note that the domain and prefix can be arbitrary, they just need to be unique to this wiki.
// (And they shouldn't contain slashes.)
parsoidConfig.setMwApi({ uri: 'http://yoursite.com/w2/api.php', domain: 'wiki2', prefix: 'wiki2' });

$ git clone ssh://<username>@gerrit.wikimedia.org:29418/mediawiki/extensions/VisualEditor.git

$ git submodule update --init

require_once("$IP/extensions/VisualEditor/VisualEditor.php");

// OPTIONAL: Enable VisualEditor in other namespaces
// By default, VE is only enabled in NS_MAIN
//$wgVisualEditorNamespaces[] = NS_PROJECT;

// Enable by default for everybody
$wgDefaultUserOptions['visualeditor-enable'] = 1;

// Don't allow users to disable it
$wgHiddenPrefs[] = 'visualeditor-enable';

// OPTIONAL: Enable VisualEditor's experimental code features
//$wgVisualEditorEnableExperimentalCode = true;

// URL to the Parsoid instance
// MUST NOT end in a slash due to Parsoid bug
$wgVirtualRestConfig['modules']['parsoid']['url'] = 'http://localhost:8000';

$ npm install
$ cd lib/ve
$ npm install 

$ grunt test

$ git checkout master
$ git pull
$ git submodule update 

$ git checkout -b [BRANCH NAME] # See tips about branch name in the tutorial

$ git status

$ git add <path/to/file>

$ git commit

$ git commit --all

$ git commit --all --amend

alias goparsoid='cd [path/to/parsoid] && git remote update && git checkout origin/master && npm install && npm start'

alias updateve='cd [path/to/mediawiki] && echo "Updating MediaWiki" && git checkout master && git pull && cd extensions/VisualEditor && echo "Updating VisualEditor" && git checkout master && git pull'

$ reload ~/.bashrc

User:Mooeypoo/VisualEditor Development

Motivation

Assumptions

Request a developer account

Setting up the system

Set up git

Install

Set up your details

Public keys

Install git-review

Setting up MediaWiki

Clone the repository

Install LAMP

Install MediaWiki

Setting up Parsoid

Before you begin

Installation

Ubuntu / Debian

Arch

RedHat/CentOS 7

RedHat/CentOS 8

Vagrant

Windows

Docker

Requirements

How to run

Examples

Configuration

localsettings.js (or settings.js) as configuration file

Multiple wikis sharing the same parsoid service

Setting up VisualEditor

Clone the extension

Add to LocalSettings.php

Setting up grunt tests

Testing

Useful Tools

gerrit reference

The commit note

First commit in the branch

Amending a previous commit

Useful shortcuts

Shortcut: update and activate parsoid

Shortcut: update MediaWiki and VisualEditor

Useful Links