This is a migrated thread and some comments may be shown as answers.

Offline documentation?

8 Answers 61 Views
General Discussion
This is a migrated thread and some comments may be shown as answers.
Philip
Top achievements
Rank 2
Philip asked on 21 May 2017, 03:16 PM

Is it possible to get the documentation in an offline format? For example, as a PDF or a downloadable git repository?

Thanks.

 

8 Answers, 1 is accepted

Sort by
0
Accepted
Nasko
Telerik team
answered on 22 May 2017, 06:34 AM
Hi Philip,

You could download the Github repository of the UWP documentation from the following link:
https://github.com/telerik/uwp-docs

Hope this helps.

Regards,
Nasko
Telerik by Progress
Do you want to have your say when we set our development plans? Do you want to know when a feature you care about is added or when a bug fixed? Explore the Telerik Feedback Portal and vote to affect the priority of the items
0
Philip
Top achievements
Rank 2
answered on 22 May 2017, 01:25 PM

Since the readme for the repo says that I can view the pages through Jekyll, I thought I'd give that a try, but I'm hitting all sorts of problems.

Now, some of the problems may be being caused by the fact that the gems specified in the bundle have version numbers that are older than current versions. I'm not a ruby or gems expert so all I've been able to do is get the bundle to be updated to what is currently available. That then gets me to the point where "jekyll serve" *runs* but then gives me errors like this:

Error reading file /mnt/c/Users/phili/Documents/GitHub/uwp-docs/common/localization/cultureservice.md: undefined method `merged_file_read_opts' for #<Jekyll:Page @name="cultureservice.md">

Similar errors are repeated for a lot of the pages before I finally get:

jekyll 3.4.3 | Error:  undefined method `downcase' for nil:NilClass

It looks like the Telerik documentation may have been built for an older version of jekyll since this error seems to be caused by a change in 3.2.x onwards (https://github.com/jekyll/jekyll/issues/5163)

Not sure if this is the right place to bring this up or if I should post it as an issue on the repo?

 

0
Nasko
Telerik team
answered on 23 May 2017, 01:35 PM
Hi Philip,

Here are some more detailed steps what you need to do in order to build the documentation locally:

1. Download and install the corresponding version of Ruby. In our case this is Ruby 2.0.0-p648. If the OS is x64 you should download the version which contain ‘x64’ in its name - Ruby 2.0.0-p648 (x64).

2. Download the Ruby DevKit for the installed version of Ruby. For version 2, this is the version that starts with DevKit-mingw64. 

The next step is to initialize the DevKit and relate it with the Ruby installation. You can do that via the command prompt. Navigate to the DevKit installation folder and execute the following commands: ruby dk.rb init - this command auto-detects the Ruby installations and add them to thee configuration file. ruby dk.rb install - this command install the DevKit and binds it to the Ruby installation.

3. Install Bundler which will help you to install Jekyll and all required gems for it. To install Bundler you can open the command prompt and execute the following command: gem install bundler .After this navigate to the directory of the documentation source, using with the command prompt. Then execute the following command: bundle install .This command looks for a Gemfile in the directory and use it to download and install the required gems.  After executing the bundle install command you have Jekyll installed.

4. To build the website using Jekyll you can execute the following command in the documentation folder via the command prompt: bundle exec jekyll serve.

Hope this helps.

Regards,
Nasko
Telerik by Progress
Do you want to have your say when we set our development plans? Do you want to know when a feature you care about is added or when a bug fixed? Explore the Telerik Feedback Portal and vote to affect the priority of the items
0
Philip
Top achievements
Rank 2
answered on 23 May 2017, 04:01 PM

Hi Nasko

Thank you for the detailed steps. I'm trying to use jekyll under WSL (bash on Windows) in order to avoid some of the complexities of running Ruby under Windows :). So I haven't had to install the DevKit, but I have successfully managed to get Ruby 2.0.0 installed and Bundler.

However, when I then go "bundle install" against the documentation repo, I get this:

Fetching gem metadata from https://rubygems.org/.........
Fetching version metadata from https://rubygems.org/..
Fetching dependency metadata from https://rubygems.org/.
activesupport-5.1.1 requires ruby version >= 2.2.2, which is incompatible with the current version, ruby 2.0.0p648

I've tried switching to a newer version of ruby so that "bundle install" works but then I'm back to the errors I reported previously.

Regards

Philip

 

0
Nasko
Telerik team
answered on 25 May 2017, 08:12 AM
Hello Philip,

We could not tell what might be the reason for the observed by you errors. Following the steps provided in my previous response worked as expected on our side - the mentioned version of ruby should be installed in order to be able to build the documentation. 

We suggest you to remove all installed versions of ruby and follow the steps strictly including the installation of the DevKit.

Regards,
Nasko
Telerik by Progress
Do you want to have your say when we set our development plans? Do you want to know when a feature you care about is added or when a bug fixed? Explore the Telerik Feedback Portal and vote to affect the priority of the items
0
Maks
Top achievements
Rank 1
answered on 16 Aug 2017, 05:46 AM
I tried to do everything you advised so nothing helped!
0
Soohwan
Top achievements
Rank 1
answered on 11 Oct 2017, 09:26 AM

My OS : windows10 64bit

C:\ruby-2.0.0-p648-x64-mingw32\Dev>ruby -v
ruby 2.0.0p648 (2015-12-16) [x64-mingw32]

 

C:\ruby-2.0.0-p648-x64-mingw32\Dev>gem install bundler
ERROR:  Could not find a valid gem 'bundler' (>= 0), here is why:
          Unable to download data from https://rubygems.org/ - SSL_connect returned=1 errno=0 state=SSLv
3 read server certificate B: certificate verify failed (https://rubygems.org/latest_specs.4.8.gz)

0
Nasko
Telerik team
answered on 13 Oct 2017, 10:12 AM
Hello Soohwan,

As this is not directly connected with any of the Telerik products, but with the ruby we can not tell for sure what might be causing the observed by you issue. We have made a small research and here are some links that could be helpful for you in order to resolve it:
http://help.rubygems.org/discussions/problems/19586-gem-install-gets-certificate-error
https://gist.github.com/luislavena/f064211759ee0f806c88

I hope this will help you.

Regards,
Nasko
Progress Telerik
Do you want to have your say when we set our development plans? Do you want to know when a feature you care about is added or when a bug fixed? Explore the Telerik Feedback Portal and vote to affect the priority of the items
Tags
General Discussion
Asked by
Philip
Top achievements
Rank 2
Answers by
Nasko
Telerik team
Philip
Top achievements
Rank 2
Maks
Top achievements
Rank 1
Soohwan
Top achievements
Rank 1
Share this question
or