Difference between revisions of "Editing the Einstein Toolkit website"

From Einstein Toolkit Documentation
Jump to: navigation, search
(→‎Overview)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==== Overview ====
 
==== Overview ====
  
−
The Einstein Toolkit website is at https://einsteintoolkit.org.  The source is hosted in a subversion repository at https://svn.einsteintoolkit.org/www.  Email maintainers@einsteintoolkit.org if you want commit access.  Authentication is via a CCT account.
+
The Einstein Toolkit website is at https://einsteintoolkit.org.  The source is hosted in a BitBucket Git repository at https://bitbucket.org/einsteintoolkit/www.
  
−
To make a change, first check out the website. You will need to check out the entire website, as the pages link to absolute URLs in /global.
+
To contribute, you can either fork the repository on BitBucket and open a pull request, or ask maintainers@einsteintoolkit.org for write access via your BitBucket account.
  
−
    svn checkout --username <username> https://svn.einsteintoolkit.org/www EinsteinToolkitWeb
+
Changes pushed to the master branch appear after a few seconds on the website.
  
−
(you can of course use git-svn if you prefer).
+
For example, if you have write access,
  
−
Since the website uses PHP, you will need to use a web server to browse your local copy of the website.
+
  git clone https://bitbucket.org/einsteintoolkit/www.git
  
−
==== Apache ====
+
Edit and test the website cloned into www, then commit and push.
  
−
If you are comfortable with Apache, you can set up a virtual host for the ET.  You may find the following fragment of /etc/apache2/extra/httpd-vhosts.conf useful as a starting point.
+
  git commit -a
−
 
+
   git push
−
    <VirtualHost *:80>
 
−
        DocumentRoot "/path/to/Sites/EinsteinToolkitWeb"
 
−
        ServerName einsteintoolkit.local
 
−
        ErrorLog "/var/log/apache2/einsteintoolkit.localhost-error_log"
 
−
        CustomLog "/var/log/apache2/einsteintoolkit.localhost-access_log" common
 
−
    </VirtualHost>
 
−
 
 
−
Add
 
−
 
 
−
    127.0.0.1      einsteintoolkit.local
 
−
 
 
−
to /etc/hosts and visit https://einsteintoolkit.local.
 
−
 
 
−
==== Docker ====
 
−
 
 
−
If you use docker, you can
 
−
 
 
−
  docker run -it --rm -v $PWD/EinsteinToolkitWeb:/var/www/html -p 8080:80 --name etwebsite php:5.6-apache
 
−
 
 
−
then visit
 
−
 
 
−
   http://<docker-ip>:8080
 
−
 
 
−
==== Committing ====
 
−
 
 
−
When you have checked your changes, just commit, and the ET website will be updated automatically.
 

Latest revision as of 15:49, 20 November 2017

Overview

The Einstein Toolkit website is at https://einsteintoolkit.org. The source is hosted in a BitBucket Git repository at https://bitbucket.org/einsteintoolkit/www.

To contribute, you can either fork the repository on BitBucket and open a pull request, or ask maintainers@einsteintoolkit.org for write access via your BitBucket account.

Changes pushed to the master branch appear after a few seconds on the website.

For example, if you have write access, 

 git clone https://bitbucket.org/einsteintoolkit/www.git

Edit and test the website cloned into www, then commit and push. 

 git commit -a
 git push
Retrieved from "https://docs.einsteintoolkit.org/et-docs/index.php?title=Editing_the_Einstein_Toolkit_website&oldid=4944"