From b12393ea1217d8c7da816c7817ffd4d7accc990c Mon Sep 17 00:00:00 2001 From: Einer von Vielen Date: Tue, 6 Jan 2015 16:14:04 +0100 Subject: Mainly it shows how to debug the red matrix (php) in a virtual machine and contribute changes via git. It will guide to the following steps: - Install a Virtual Machine - Install Apache Web Server - Install PHP, MySQL, phpMyAdmin - Fork the project on github to be able contribute - Install the RED Matrix - Debug the server via eclipse - Contribute your changes via github --- doc/main.bb | 1 + 1 file changed, 1 insertion(+) (limited to 'doc') diff --git a/doc/main.bb b/doc/main.bb index c9984b1f6..1ea844168 100644 --- a/doc/main.bb +++ b/doc/main.bb @@ -64,6 +64,7 @@ Zot is the great new communicaton protocol invented especially for the RedMatrix [zrl=[baseurl]/help/to_do_doco]To-Do list for the Red Documentation Project[/zrl] [zrl=[baseurl]/help/to_do_code]To-Do list for Developers[/zrl] [zrl=[baseurl]/help/git_for_non_developers]Git for Non-Developers[/zrl] +[zrl=[baseurl]/help/dev_beginner]Sep-for-step manual for beginning developers[/zrl] [size=large][b]Frequently Asked Questions For Developers[/b][/size] [zrl=[baseurl]/help/faq_developers]FAQ For Developers[/zrl] -- cgit v1.2.3 From a5766534fef52da92ddedc8e04008b6b4107c209 Mon Sep 17 00:00:00 2001 From: Einer von Vielen Date: Tue, 6 Jan 2015 16:22:30 +0100 Subject: Mainly it shows how to debug the red matrix (php) in a virtual machine and contribute changes via git. It will guide to the following steps: - Install a Virtual Machine - Install Apache Web Server - Install PHP, MySQL, phpMyAdmin - Fork the project on github to be able contribute - Install the RED Matrix - Debug the server via eclipse - Contribute your changes via github --- doc/dev_beginner.bb | 393 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 393 insertions(+) create mode 100644 doc/dev_beginner.bb (limited to 'doc') diff --git a/doc/dev_beginner.bb b/doc/dev_beginner.bb new file mode 100644 index 000000000..83c9dbb39 --- /dev/null +++ b/doc/dev_beginner.bb @@ -0,0 +1,393 @@ +[h2]You want to contribute to the Red Matrix?[/h2] +[b]...and don't know really how to start? +Then this is for you...[/b] + +You want to lean how to: +[list] +[*] debug the Red Matrix, +[*] contribute code to the project, +[*] optionally - do it all from inside a virtual machine? +[/list] + +This manual was tested for +[list] +[*] Lubuntu Linux as host OS +[*] Debian as guest OS running in a VM +[/list] + +[h2]Content[/h2] + +In this manual you will +[list=1] +[*] Install a Virtual Machine (optional) +[*] Install Apache Web Server +[*] Install PHP, MySQL, phpMyAdmin +[*] Fork the project on github to be able contribute +[*] Install the RED Matrix +[*] Debug the server via eclipse +[*] Contribute your changes via github +[/list] + +[h2]Install a Virtual Machine (optional)[/h2] + +[h3]Install KVM - Kernel-based Virtual Machine[/h3] + +[url=https://wiki.debian.org/KVM]Hier[/url] die Anleitung für Linux Debian. +Zusammenfassung der Anleitung (Schritt-für-Schritt für Linux): +[list=1] +[*] KVM installieren +[code]# sudo apt-get install qemu-kvm libvirt-bin[/code] +[*] Sich selbst zur Gruppe libvirt hinzufügen [code]# sudo adduser libvirt[/code] +[*] Grafische Oberfläche zur Verwaltung (Installation, Konfiguration,...) von virtuellen Maschinen installieren [code]# sudo apt-get install virt-manager[/code] +[*] Betriebssystem der Wahl herunterladen, das man halt später in der virtuelle Machine laufen lassen will zum Beispiel Linux Mint Debian oder debian ([url=http://ftp.nl.debian.org/debian/dists/wheezy/main/installer-amd64/current/images/netboot/mini.iso]mini.iso[/url]) +[*] Den Virt-Manager starten +- Neue virtuelle Maschine anlegen (Klick auf Icon) +- Als Installations-Medium das ISO-Image wählen, dass im Schritt vorher herunter geladen wurde, in unserem Fall Linux Mint Debian oder Lubuntu für ältere Rechner +- Optional: Virtuelle Maschine konfigurieren, genauer: Wieviel Hauptspeicher darf sie benutzen, wieviele CPUs,... +- Virtuelle Maschine starten. Ergebnis: Linux Mint startet in einem eignen Fenster. Dort kann jetzt im Internet gesurft werden, ohne das der "eigene" Computer verseucht wird. +[*] (optional) Netzwerkfehler nach Neustart des Wirts vermeiden +[code]# virsh net-start default +# virsh net-autostart default[/code] +[/list] + +[h3]Install Debian Linux in the VM[/h3] + +Download an ISO image to install the current Debian [url=https://www.debian.org/CD/netinst/]here[/url]. Choose "amd64" for a consumer computer / notebook. + +Open the Virtual Machine Manager, create a new VM and install Debian from the ISO image you download just befor. + + +[h2]Install Apache Webserver[/h2] + +Make yourself root +[code]su -l[/code] + +Create the standard group for the Apache webserver +[code]groupadd www-data[/code] +might exist already + +[code]usermod -a -G www-data www-data[/code] + +Check if the system is really up to date +[code]apt-get update[/code] + +Optional restart services after installation +[code]reboot[/code] + +If you restarted, make yourself root +[code]su -l[/code] + +Install Apache: [code] +apt-get install apache2 apache2-doc apache2-utils[/code] + +Open webbrowser on PC and check [url=localhost]localhost[/url] +Should show you a page like "It works" + +(Source [url=http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#]http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#[/url]) + + +[h2]Install PHP, MaySQL, phpMyAdmin[/h2] + +[code]su -l +apt-get install libapache2-mod-php5 php5 php-pear php5-xcache php5-curl php5-mcrypt php5-xdebug +apt-get install php5-mysql +apt-get install mysql-server mysql-client[/code] +enter and note the mysql passwort + +Optional since its already enabled during phpmyadmin setup +[code] +php5enmod mcrypt +[/code] + +Install php myadmin +[code]apt-get install phpmyadmin[/code] + +Configuring phpmyadmin +- Select apache2 (hint: use the tab key to select) +- Configure database for phpmyadmin with dbconfig-common?: Choose Yes + +(Source #^[url=http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#]http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#[/url]) + +[b]Enable rewrite[/b] + +The default installation of Apache2 comes with mod_rewrite installed. To check whether this is the case, verify the existence of /etc/apache2/mods-available/rewrite.load + +[code] +pi@pi /var/www $ nano /etc/apache2/mods-available/rewrite.load +[/code] + + (You should find the contendt: LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so) +To enable and load mod_rewrite, do the rest of steps. +Create a symbolic link in /etc/apache2/mods-enabled + +[code] +cd /var/www +pi@pi /var/www $ a2enmod rewrite +[/code] + +Then open up the following file, and replace every occurrence of "AllowOverride None" with "AllowOverride all". + +[code] +pi@pi /var/www $nano /etc/apache2/apache2.conf +[/code] +or +[code] +root@debian:/var# gedit /etc/apache2/sites-enabled/000-default +[/code] + +Finally, restart Apache2. + +[code] +pi@pi /var/www $service apache2 restart +[/code] + +[b]Test installation[/b] + +[code]cd /var/www[/code] + +create a php file to test the php installation[code]sudo nano phpinfo.php[/code] + +Insert into the file: +[code] + +[/code] +(save CTRL+0, ENTER, CTRL+X) + +open webbrowser on PC and try #^[url=http://localhost/phpinfo.php]http://localhost/phpinfo.php[/url] (page shows infos on php) + +connect phpMyAdmin with MySQL database [code]nano /etc/apache2/apache2.conf +[/code] +- CTRL+V... to the end of the file +- Insert at the end of the file: (save CTRL+0, ENTER, CTRL+X)[code]Include /etc/phpmyadmin/apache.conf[/code] + +restart apache +[code]/etc/init.d/apache2 restart +apt-get update +apt-get upgrade +reboot[/code] + +(Source #^[url=http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#]http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#[/url]) + + +[b]phpMyAdmin[/b] + +open webbrowser on PC and try #^[url=http://localhost/phpmyadmin]http://localhost/phpmyadmin[/url] + +(Source #^[url=http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#]http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#[/url]) + + +[b]Create an empty database... that is later used by RED[/b] + +open webbrowser on PC and try #^[url=http://localhost/phpmyadmin]http://localhost/phpmyadmin[/url] + +Create an empty database, for example named "red". +Create a database user, for example "red". +Grand all rights for the user "red" to the database "red". + +Note the access details (hostname, username, password, database name). + + +[h2]Fork the project on github to be able contribute[/h2] + +Please follow the instruction in offiical [url=http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project] documentation[/url] of git. +It is a good idea to read the whole manual! Git is different to other version control systems in many ways. + +You should +[list] +[*] create an account at github.com +[*] fork https://github.com/friendica/red +[*] fork https://github.com/friendica/red-addons +[/list] + + +[h2]Install RED and its Addons[/h2] + +You should have created an account on github and forked the projects befor you procced. + +Delete the directory www +[code]pi@pi /var/www/html $ cd .. +rm -R www/ +[/code] + +Install git (and optionally git-gui a client gui) +[code]apt-get install git git-gui[/code] + +Download the main project red and red-addons +[code] +root@debian:/var# git clone https://github.com/einervonvielen/red www +root@debian:/var# cd www/ +root@debian:/var/www# git clone https://github.com/einervonvielen/red-addons addon +[/code] + +Make this extra folder +[code] +root@debian:/var/www# mkdir -p "store/[data]/smarty3" +[/code] + +Create .htconfig.php and make it writable by the webserver +[code] +root@debian:/var# cd www/ +root@debian:/var/www# chmod ou+w .htconfig.php +[/code] + +Make user www-data (webserver) is the owner all the project files +[code] +root@debian:/var/www# cd .. +root@debian:/var# chown -R www-data:www-data www/ +[/code] + +Add yourself ("surfer" in this example) to the group www-data. Why? Later you want to modify files in eclipse or in another editor. +Then make all files writable by the group www-date you are now a member of. +[code] +root@debian:/var/www# usermod -G www-data surfer +root@debian:/var# chmod -R g+w www/ +[/code] + +Restart the computer (or vm) +If you are still not able to modify the project files you can check the members of the group www-data with +[code] +cat /etc/group +[/code] + +Open http://localhost and init the matrix + +Befor you register a first user switch of the registration mails. +Open /var/www/.htconfig.php +and make sure "0" is set in this line +[code] +$a->config['system']['verify_email'] = 0; +[/code] +This should be able to change the file as "yourself" (instead of using root or www-data). + + +Run the poller to pick up the recent "public" postings of your friends +Set up a cron job or scheduled task to run the poller once every 5-10 +minutes to pick up the recent "public" postings of your friends + +[code] +sudo crontab -e +[/code] + +Add +[code] +*/10 * * * * cd /var/www/; /usr/bin/php include/poller.php +[/code] + +If you don't know the path to PHP type +[code] +sudo whereis php +[/code] + + +[h2]Debug the server via eclipse[/h2] + +[h3]Check the configuration of xdebug[/h3] + +You shoud have installed xdebug befor +[code] +sudo apt-get install php5-xdebug +[/code] + +Configuring Xdebug + +Open your terminal and type as root (su -l) +[code] +gedit /etc/php5/mods-available/xdebug.ini +[/code] + +if the file is empty try this location +[code] +gedit /etc/php5/conf.d/xdebug.ini +[/code] + +That command should open the text editor gedit with the Xdebug configuration file +At the end of the file content append the following text + +xdebug.remote_enable=on +xdebug.remote_handler=dbgp +xdebug.remote_host=localhost +xdebug.remote_port=9000 + +Save changes and close the editor. +In you terminal type to restart the web server. +[code] +sudo service apache2 restart +[/code] + + +[h3]Install Eclipse and start debugging[/h3] + +Install eclipse. +Start eclipse with default worspace (or as you like) + +Install the PHP plugin +Menu > Help > Install new software... +Install "PHP Developnent Tools ..." + +Menu > Window > Preferences... +> General > Webbrowser > Change to "Use external web browser" +> PHP > Debug > Debug Settings > PHP Debugger > Change to "XDebug" + +Menu > File > New Project > Choose PHP > "PHP Project" +> Choose Create project at existing location and "/var/www" + +Open index.php and "Debug as..." +Choose as Launch URL: "http://localhost/" + +Expected: +[list] +[*] The web browser starts +[*] The debugger will stop at the first php line +[/list] + + +[h2]Contribute your changes via github[/h2] + +(There is a related page in this docs: [zrl=[baseurl]/help/git_for_non_developers]Git for Non-Developers[/zrl]) +As stated befor it is recommended to read the official documentation [url=http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project]GitHub-Contributing-to-a-Project[/url] of git. + +Make sure you have set your data +[code] +surfer@debian:/var/www$ git config --global user.name "Your Name" +surfer@debian:/var/www$ git config --global user.email "your@mail.com" +[/code] + + + +Create a descriptive topic branch +[code] +surfer@debian:/var/www$ git checkout -b doc_dev_beginning +[/code] + +Make your changes. In this example it is a new doc file. + +Check your modifications +[code] +surfer@debian:/var/www$ git status +[/code] + +Add (stage) the new file +[code] +surfer@debian:/var/www$ git add doc/nb-no/dev_beginner.bb +[/code] + +Commit the changes to your local branch +[code] +surfer@debian:/var/www$ git commit +[/code] + +Make sure your local repository is up-to-date with the main project. +Add the original repository as a remote named “upstream” if not done yet +[code] +surfer@debian:/var/www$ git remote add upstream https://github.com/einervonvielen/red +[/code] + +Fetch the newest work from that remote +[code] +surfer@debian:/var/www$ git fetch upstream +[/code] + + +#include doc/macros/main_footer.bb; \ No newline at end of file -- cgit v1.2.3 From ba428533bb1e33c3f81571e6776c98df9f4dac3c Mon Sep 17 00:00:00 2001 From: Einer von Vielen Date: Tue, 6 Jan 2015 17:27:52 +0100 Subject: added modification of branch --- doc/dev_beginner.bb | 117 ++++++++++++++++++++++++++++------------------------ 1 file changed, 64 insertions(+), 53 deletions(-) (limited to 'doc') diff --git a/doc/dev_beginner.bb b/doc/dev_beginner.bb index 83c9dbb39..28acd7103 100644 --- a/doc/dev_beginner.bb +++ b/doc/dev_beginner.bb @@ -19,7 +19,7 @@ This manual was tested for In this manual you will [list=1] -[*] Install a Virtual Machine (optional) +[*] Install a Virtual Machine (KVM) [*] Install Apache Web Server [*] Install PHP, MySQL, phpMyAdmin [*] Fork the project on github to be able contribute @@ -28,38 +28,30 @@ In this manual you will [*] Contribute your changes via github [/list] -[h2]Install a Virtual Machine (optional)[/h2] +[h2]Install a Virtual Machine (KVM)[/h2] -[h3]Install KVM - Kernel-based Virtual Machine[/h3] - -[url=https://wiki.debian.org/KVM]Hier[/url] die Anleitung für Linux Debian. -Zusammenfassung der Anleitung (Schritt-für-Schritt für Linux): +[url=https://wiki.debian.org/KVM]Here[/url] the installation guide for Linux Debian. +The summary: [list=1] -[*] KVM installieren -[code]# sudo apt-get install qemu-kvm libvirt-bin[/code] -[*] Sich selbst zur Gruppe libvirt hinzufügen [code]# sudo adduser libvirt[/code] -[*] Grafische Oberfläche zur Verwaltung (Installation, Konfiguration,...) von virtuellen Maschinen installieren [code]# sudo apt-get install virt-manager[/code] -[*] Betriebssystem der Wahl herunterladen, das man halt später in der virtuelle Machine laufen lassen will zum Beispiel Linux Mint Debian oder debian ([url=http://ftp.nl.debian.org/debian/dists/wheezy/main/installer-amd64/current/images/netboot/mini.iso]mini.iso[/url]) -[*] Den Virt-Manager starten -- Neue virtuelle Maschine anlegen (Klick auf Icon) -- Als Installations-Medium das ISO-Image wählen, dass im Schritt vorher herunter geladen wurde, in unserem Fall Linux Mint Debian oder Lubuntu für ältere Rechner -- Optional: Virtuelle Maschine konfigurieren, genauer: Wieviel Hauptspeicher darf sie benutzen, wieviele CPUs,... -- Virtuelle Maschine starten. Ergebnis: Linux Mint startet in einem eignen Fenster. Dort kann jetzt im Internet gesurft werden, ohne das der "eigene" Computer verseucht wird. -[*] (optional) Netzwerkfehler nach Neustart des Wirts vermeiden +[*] install KVM +[code]# apt-get install qemu-kvm libvirt-bin[/code] +[*] add yourself to the group libvirt [code]# adduser libvirt[/code] +[*] install gui to manage virtual machines [code]# apt-get install virt-manager[/code] +[*] download an operating system to run inside the vm ([url=http://ftp.nl.debian.org/debian/dists/wheezy/main/installer-amd64/current/images/netboot/mini.iso]mini.iso[/url]) +[*] start the virt manager +- create new virtual machine (click on icon) +- choose your iso image (just downloaded) as installation source +- optional: configure the new vm: ram, cpu's,... +- start virtual machine > result: linux debian starts in a new window. +[*] (optional) avoid network errors after restart of host os [code]# virsh net-start default # virsh net-autostart default[/code] [/list] -[h3]Install Debian Linux in the VM[/h3] - -Download an ISO image to install the current Debian [url=https://www.debian.org/CD/netinst/]here[/url]. Choose "amd64" for a consumer computer / notebook. - -Open the Virtual Machine Manager, create a new VM and install Debian from the ISO image you download just befor. - [h2]Install Apache Webserver[/h2] -Make yourself root +Open a terminal and make yourself root [code]su -l[/code] Create the standard group for the Apache webserver @@ -69,7 +61,8 @@ might exist already [code]usermod -a -G www-data www-data[/code] Check if the system is really up to date -[code]apt-get update[/code] +[code]apt-get update +apt-get upgrade[/code] Optional restart services after installation [code]reboot[/code] @@ -86,7 +79,7 @@ Should show you a page like "It works" (Source [url=http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#]http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#[/url]) -[h2]Install PHP, MaySQL, phpMyAdmin[/h2] +[h2]Install PHP, MySQL, phpMyAdmin[/h2] [code]su -l apt-get install libapache2-mod-php5 php5 php-pear php5-xcache php5-curl php5-mcrypt php5-xdebug @@ -113,22 +106,22 @@ Configuring phpmyadmin The default installation of Apache2 comes with mod_rewrite installed. To check whether this is the case, verify the existence of /etc/apache2/mods-available/rewrite.load [code] -pi@pi /var/www $ nano /etc/apache2/mods-available/rewrite.load +root@debian /var/www $ nano /etc/apache2/mods-available/rewrite.load [/code] - (You should find the contendt: LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so) + (You should find the content: LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so) To enable and load mod_rewrite, do the rest of steps. Create a symbolic link in /etc/apache2/mods-enabled [code] cd /var/www -pi@pi /var/www $ a2enmod rewrite +root@debian /var/www $ a2enmod rewrite [/code] Then open up the following file, and replace every occurrence of "AllowOverride None" with "AllowOverride all". [code] -pi@pi /var/www $nano /etc/apache2/apache2.conf +root@debian /var/www $nano /etc/apache2/apache2.conf [/code] or [code] @@ -138,14 +131,14 @@ root@debian:/var# gedit /etc/apache2/sites-enabled/000-default Finally, restart Apache2. [code] -pi@pi /var/www $service apache2 restart +root@debian /var/www $service apache2 restart [/code] [b]Test installation[/b] [code]cd /var/www[/code] -create a php file to test the php installation[code]sudo nano phpinfo.php[/code] +create a php file to test the php installation[code]nano phpinfo.php[/code] Insert into the file: [code] @@ -168,9 +161,6 @@ apt-get update apt-get upgrade reboot[/code] -(Source #^[url=http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#]http://www.manfred-steger.de/tuts/20-der-eigene-webserver-mit-dem-raspberry-pi#[/url]) - - [b]phpMyAdmin[/b] open webbrowser on PC and try #^[url=http://localhost/phpmyadmin]http://localhost/phpmyadmin[/url] @@ -184,7 +174,7 @@ open webbrowser on PC and try #^[url=http://localhost/phpmyadmin]http://localhos Create an empty database, for example named "red". Create a database user, for example "red". -Grand all rights for the user "red" to the database "red". +Grant all rights for the user "red" to the database "red". Note the access details (hostname, username, password, database name). @@ -207,7 +197,7 @@ You should You should have created an account on github and forked the projects befor you procced. Delete the directory www -[code]pi@pi /var/www/html $ cd .. +[code]root@debian /var/www/html $ cd .. rm -R www/ [/code] @@ -253,21 +243,21 @@ cat /etc/group Open http://localhost and init the matrix -Befor you register a first user switch of the registration mails. +Befor you register a first user switch off the registration mails. Open /var/www/.htconfig.php and make sure "0" is set in this line [code] $a->config['system']['verify_email'] = 0; [/code] -This should be able to change the file as "yourself" (instead of using root or www-data). - +You should be able to change the file as "yourself" (instead of using root or www-data). +Important! Run the poller to pick up the recent "public" postings of your friends Set up a cron job or scheduled task to run the poller once every 5-10 minutes to pick up the recent "public" postings of your friends [code] -sudo crontab -e +crontab -e [/code] Add @@ -277,7 +267,7 @@ Add If you don't know the path to PHP type [code] -sudo whereis php +whereis php [/code] @@ -285,9 +275,9 @@ sudo whereis php [h3]Check the configuration of xdebug[/h3] -You shoud have installed xdebug befor +You shoud already have installed xdebug in the steps befor [code] -sudo apt-get install php5-xdebug +apt-get install php5-xdebug [/code] Configuring Xdebug @@ -313,7 +303,7 @@ xdebug.remote_port=9000 Save changes and close the editor. In you terminal type to restart the web server. [code] -sudo service apache2 restart +service apache2 restart [/code] @@ -326,13 +316,16 @@ Install the PHP plugin Menu > Help > Install new software... Install "PHP Developnent Tools ..." +Configure the PHP plugin Menu > Window > Preferences... > General > Webbrowser > Change to "Use external web browser" > PHP > Debug > Debug Settings > PHP Debugger > Change to "XDebug" +Create a new PHP project Menu > File > New Project > Choose PHP > "PHP Project" > Choose Create project at existing location and "/var/www" +Start debugging Open index.php and "Debug as..." Choose as Launch URL: "http://localhost/" @@ -354,11 +347,25 @@ surfer@debian:/var/www$ git config --global user.name "Your Name" surfer@debian:/var/www$ git config --global user.email "your@mail.com" [/code] +Make sure your local repository is up-to-date with the main project. +Add the original repository as a remote named “upstream” if not done yet +[code] +surfer@debian:/var/www$ git remote add upstream https://github.com/friendica/red +[/code] +Fetch the newest work from that remote +[code] +surfer@debian:/var/www$ git fetch upstream +[/code] Create a descriptive topic branch [code] -surfer@debian:/var/www$ git checkout -b doc_dev_beginning +surfer@debian:/var/www$ git checkout -b dev_beginning +[/code] + +Hint: You can list the branches +[code] +surfer@debian:/var/www$ git branch -v [/code] Make your changes. In this example it is a new doc file. @@ -370,23 +377,27 @@ surfer@debian:/var/www$ git status Add (stage) the new file [code] -surfer@debian:/var/www$ git add doc/nb-no/dev_beginner.bb +surfer@debian:/var/www$ git add doc/dev_beginner.bb [/code] -Commit the changes to your local branch +Commit the changes to your local branch. This will open an editor to provide a message. [code] surfer@debian:/var/www$ git commit [/code] -Make sure your local repository is up-to-date with the main project. -Add the original repository as a remote named “upstream” if not done yet +Push back up to the same topic branch online [code] -surfer@debian:/var/www$ git remote add upstream https://github.com/einervonvielen/red +surfer@debian:/var/www$ git push origin dev_beginning [/code] -Fetch the newest work from that remote +Now you get to your (online) account at github and create the pull request. + +In case the main devolpers want you to change something. +Make the changes, check them, commit (to local repository), push (to online repository) [code] -surfer@debian:/var/www$ git fetch upstream +surfer@debian:/var/www$ git status +surfer@debian:/var/www$ git commit -a -m "added modification of branch" +surfer@debian:/var/www$ git push origin dev_beginning [/code] -- cgit v1.2.3 From 2f0d196f2829b3a37d1f2294241d5e560fb349e9 Mon Sep 17 00:00:00 2001 From: Einer von Vielen Date: Tue, 6 Jan 2015 17:32:57 +0100 Subject: spelling --- doc/dev_beginner.bb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/dev_beginner.bb b/doc/dev_beginner.bb index 28acd7103..4fc0fe455 100644 --- a/doc/dev_beginner.bb +++ b/doc/dev_beginner.bb @@ -6,7 +6,7 @@ You want to lean how to: [list] [*] debug the Red Matrix, [*] contribute code to the project, -[*] optionally - do it all from inside a virtual machine? +[*] optionally - do it all from inside a virtual machine [/list] This manual was tested for @@ -390,7 +390,7 @@ Push back up to the same topic branch online surfer@debian:/var/www$ git push origin dev_beginning [/code] -Now you get to your (online) account at github and create the pull request. +Now you can go to your (online) account at github and create the pull request. In case the main devolpers want you to change something. Make the changes, check them, commit (to local repository), push (to online repository) -- cgit v1.2.3 From 88d26f1f8716ce1a9c59aae56f78e6a7d0ec8ad1 Mon Sep 17 00:00:00 2001 From: Einer von Vielen Date: Tue, 6 Jan 2015 19:07:59 +0100 Subject: Corrected errors in chapter 'Contribute your changes via github' - changed commit statement - changed push statement (it pointed to the orign) --- doc/dev_beginner.bb | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/dev_beginner.bb b/doc/dev_beginner.bb index 4fc0fe455..c00cafb9d 100644 --- a/doc/dev_beginner.bb +++ b/doc/dev_beginner.bb @@ -347,6 +347,11 @@ surfer@debian:/var/www$ git config --global user.name "Your Name" surfer@debian:/var/www$ git config --global user.email "your@mail.com" [/code] +Create a descriptive topic branch +[code] +surfer@debian:/var/www$ git checkout -b dev_beginning +[/code] + Make sure your local repository is up-to-date with the main project. Add the original repository as a remote named “upstream” if not done yet [code] @@ -356,11 +361,7 @@ surfer@debian:/var/www$ git remote add upstream https://github.com/friendica/red Fetch the newest work from that remote [code] surfer@debian:/var/www$ git fetch upstream -[/code] - -Create a descriptive topic branch -[code] -surfer@debian:/var/www$ git checkout -b dev_beginning +surfer@debian:/var/www$ git merge upstream/master [/code] Hint: You can list the branches @@ -382,12 +383,12 @@ surfer@debian:/var/www$ git add doc/dev_beginner.bb Commit the changes to your local branch. This will open an editor to provide a message. [code] -surfer@debian:/var/www$ git commit +surfer@debian:/var/www$ git commit -a [/code] Push back up to the same topic branch online [code] -surfer@debian:/var/www$ git push origin dev_beginning +surfer@debian:/var/www$ git push [/code] Now you can go to your (online) account at github and create the pull request. -- cgit v1.2.3 From bb67ab1fbf2271ed7dead5da72f665115fd0c9fe Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 6 Jan 2015 15:30:54 -0800 Subject: this brings us up to date --- doc/history.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/history.md b/doc/history.md index 12091d205..f567ff2f0 100644 --- a/doc/history.md +++ b/doc/history.md @@ -44,6 +44,6 @@ The concept of identity-aware content was alien to anything that existed previou Over time a few federation components re-emerged. The ability to view RSS feeds was important to many people. Diaspora never really managed to re-write their protocol, so that was re-implemented and allowed RedMatrix to connect with Diaspora and Friendica again (Friendica still had their Diaspora protocol intact, so this was the most common language now remaining on the free web - despite its faults). Diaspora communications aren't able to make use of the advanced identity features, but they work for basic communications. -That brings us up to the present. Where will RedMatrix go from here? I don't know. That's up to you. +Mike resigned from the project as an active coordinator in early 2015. #include doc/macros/main_footer.bb; -- cgit v1.2.3