Getting Started

Requirements

To be able to edit or contribute into the Telerik UI for WPF documentation you should:

1. have a git tool of your choice, so to clone, pull and push changes (e.g., GitBash, GitHub for Windows, SourceTree, etc.);
2. install Ruby 1.9.3 and the Ruby DevKit (make sure the installation instructions for the DevKit are followed properly);
3. install the Bundler gem for Ruby.

Running Locally

Once you have these packages installed, you need to download the content that you will edit and build locally.

Note: Step 1 and 2 are needed only for the first time you run the local documentation. If Jekyll server has stopped—re-run it by using the jekyll serve command.

1. Clone the repository git clone [email protected]:telerik/xaml-docs.git;

2. Navigate to the repository page

3. Open a console in that page. (Some of us prefer to use the GitHub console instead of CMD. It is a personal choice. Both are working.).

4. If the GitHub console is installed you can just right click and select the “Git Bash” menu item.

5. If the destination is correct execute the jekyll serve command. If everything is OK, Jekyll should start a local server and host the documentation for you.

6. Open the server address from any browser and see the result. The help should be built for WPF. If you need to build it for Silverlight you should use the following command: jekyll serve --config _config.yml,_silverlight.yml

Editing

The content files are written in Markdown, based on the specification followed for Jekyll. You can read more about it in daringfireball.net/projects/markdown/.

Some elements, like notes, captions, tabbed code blocks, etc., are rendered via custom Jekyll plugins. Exact specification how to use them is available in Markdown Syntax.

Important: Always pull with re-base git pull --rebase origin master, before you push commits to the remote git push origin master.