Skip to content
This repository has been archived by the owner on Apr 3, 2020. It is now read-only.

editing the wiki

Jump to bottom
James Ketrenos edited this page Sep 6, 2013 · 27 revisions

Logistics

The Crosswalk wiki is managed by the Gollum infrastructure hosted on GitHub.

To edit content you need to have commit access to the crosswalk-website project.

Workflow

The most efficient workflow for editing content is to do so with a local install of Gollum. The steps for installing Gollum are documented in the Crosswalk website's README.md page in the section Gollum and the Wiki.)

Once you have Gollum running locally, you can point your browser to http://localhost:4567 and edit the content in the live preview editor. When you are satisfied with your content, you can push it back to the GitHub project.

Wiki in the Website

The best way to see your content is to review it in the website before pushing it to GitHub. To do that, you need to install a local version of the Crosswalk website. The detailed steps for doing that are documented in the Crosswalk website README.md. The quick steps on an Ubuntu system are as follows:

# Install Ruby >=1.9.1
sudo apt-get install ruby1.9.3 rubygems1.9
# Select gem1.9.1
sudo update-alternatives --config gem
# Select ruby1.9.1
sudo update-alternatives --config ruby
# Install Gollum and the various markup parsers
sudo gem install gollum redcarpet org-ruby wikicloth
# Install the SASS compiler (with source map support)
sudo gem install sass -v ">=3.3.0alpha" --pre
# Change to the root path of your web server installation path
cd /var/www
# Clone the Crosswalk site
git clone [email protected]:crosswalk-project/crosswalk-website
cd crosswalk-website
# Clone the Crosswalk website wiki
cd wiki
git clone [email protected]:crosswalk-project/crosswalk-website.wiki.git --bare .git
sed -i -e 's/bare = true/bare = false/' .git/config
git checkout
cd ..
# Change the permissions of all the files checked out so the web-server software can edit it
sudo chown :www-data . -R
sudo chmod g+rwX . -R
# Launch Gollum pointing to where you just cloned the wiki
gollum --base-path wiki --live-preview /var/www/crosswalk-website/wiki &
# Launch a browser pointing to the website
xdg-open http://localhost/crosswalk-website/#wiki
# Launch a browser pointing to the Wiki content
xdg-open http://localhost:4567

And you're good to go. You can edit your content in the tab pointing to the Gollum server (port 4567) and after you click the Save icon for any content, you can change over to your localhost/crosswalk-website tab and hit refresh to see the new content.

For the above to all work, you also need to have Apache2 installed, with PHP enabled. In your Apache2 installation you must disable MultiViews and enable FollowSymLinks in your site configuration (typically /etc/apache2/sites-enabled/000-default)

Once you're done editing content, you can push your Wiki changes back to GitHub:

## Quick steps
The general workflow cycle is:
```sh
cd /var/www/crosswalk-website/wiki
git push origin master

You can verify your content is correct by viewing the pages at http://github.com/crosswalk-project/crosswalk-website/wiki.

Content will be merged to the live website during the next release/update cycle of Crosswalk.

Clone this wiki locally