Getting Started

Requirements

To be able to edit or contribute into the Telerik UI for WinForms 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 the above requirements are fulfilled, you can generate a static website from the Telerik UI for WinForms documentation's source code and browse it locally by using the following commands:

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 git@github.com:telerik/winforms-docs.git;

2. Run bundle install;

3. Edit _config.yml file with the desired host and port properties:

   Note: This is not mandatory. The default port is 4000 and the server runs on localhost by default. Thus, you do not need to modify the config file and keep it checked out.

   Tip: You can Deploy the documentation to your IIS for easier access.

   The application virtual path

    host: "localhost"
    port: "8080" # The port configuration is optional. If not configured, its default value is 4000.
    baseurl: "/aspnet-ajax"
   

4. Modify _plugins/slug.rb like below:

   11: page.url 12: ## page.url.sub('.html', '')

   This line of code removes the .html extensions from all links. It serves SEO optimizations in the live documentation. If you deploy the Jekyll site on IIS with a URL Rewriter module installed, you can leave it as it is.

5. Run bundle exec jekyll serve

6. Open "http://[host]:[port]/devtools/winforms/introduction.html" in your browser

   [host] and [port] should be additionally configured in the _config.yml file. See step 3. By default, you would need to open a URL like the following to start browsing: http://localhost:4000/devtools/winforms/introduction.html

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 rebase git pull --rebase origin master before you push commits to the remote git push origin master.