LDSA Wiki

This Wiki is hosted on https://ldssa.github.io/wiki/. The Wiki pages are stored inside /docs/_docs folders as markdown files.

How to edit an existing page

If you want to edit an existing page, browse it in the pages directory /docs/_docs/.

1. Locate the file (page) you want to edit and click on it;
2. Click the edit button (pencil symbol) on the top-right corner to edit the page;
3. When you're ready, insert a commit message at the end of the page and select the option Create a new branch. Click Propose changes;
4. The Documentation Team will review and approve your changes.

Note: Please store any images in /docs/images.

Alternatively, you can clone this repo, make your changes locally on a new branch and create a merge request.

How to create a new page

If you want to edit an existing page, browse it in the pages directory /docs/_docs/.

1. Navigate to the folder (menu category) where you want to store your page;

2. Click the button "Add file" on the top-right corner to start editing the new page;

3. Insert the header first. This is where you specify to what sidebar category the page belongs to, its title and the order in which it appears on that sidebar category.

   Example:

   ---
   title: Application Process
   category: Applicants
   order: 1
   ---

4. When you're ready, insert a commit message at the end of the page and select the option Create a new branch. Click Propose changes;

5. The Documentation Team will review and approve your changes.

Note: Please store any images in /docs/images.

Alternatively, you can clone this repo, make your changes locally on a new branch and create a merge request.

Develop

This section describes the necessary packages to be installed if you want to copy and run the website on your local machine.

1. Install necessary packages

1. Update and install all prerequisites:

   sudo apt-get update
   sudo apt-get install ruby-full build-essential zlib1g-dev

2. Add the environment variables to ~/.bashrc by running:

   echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
   echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
   echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
   source ~/.bashrc

3. Install jekyll and bundler

   sudo gem install jekyll
   sudo gem install bundler -v '< 2.0'

That's it!

2. Run the site locally

Run the following inside the docs/ directory:

bundle install

bundle exec jekyll serve

References

• Template source

• Installing Jekyll on Ubuntu