Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(JekyllOnWindows): Add a new Installation way #6141

Merged
merged 4 commits into from
Jun 16, 2017
Merged

docs(JekyllOnWindows): Add a new Installation way #6141

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dfa3782
docs(JekyllOnWindows): Add a new Installation way
KeJunMao Jun 15, 2017
f2ed44d
docs(windows): update Installation via RubyInstaller
KeJunMao Jun 15, 2017
956acda
docs(windows): Installation via RubyInstaller
KeJunMao Jun 15, 2017
d63a0a0
docs(windows): update windows
KeJunMao Jun 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/_docs/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,27 @@ In the future the installation process of the github-pages should be as simple a
RubyInstaller is a self-contained Windows-based installer that includes the Ruby language, an execution environment, important documentation, and more.

1. Install a package manager for Windows called [RubyInstaller](https://rubyinstaller.org/).
2. Install Jekyll via RubyInstaller: `gem install bundler jekyll`
3. Reopen a command prompt and run Jekyll: `jekyll -v`
2. Install Jekyll and Bundler via a command prompt window: `gem install jekyll bundler`
3. Check if the installation is accessible: `jekyll -v`

see [Autoinstall Jekyll for windows](https://github.com/KeJunMao/fastjekyll#autoinstall-jekyll-for-windows)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capital S here, please, i.e. See. Same for the W in Autoinstall Jekyll for Windows.


### auto-regeneration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capital A here, please.


Although jekyll would suggest:

```
Please add the following to your Gemfile to avoid polling for changes:
gem 'wdm', '>= 0.1.0' if Gem.win_platform?
```

But auto-regeneration still works fine.Its an outdated warning IMO.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although and but don't play well together. Please update L#194 to:

Auto-regeneration will work fine without including `gem 'wdm'`

### time-zone

Requires one gem:

```shell
gem install tzinfo-data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Though tzinfo-data is required, you don't have to install it separately.
It is already included in a new Gemfile generated by jekyll new from v3.4.0 For sites generated with older versions, they should add it to their Gemfile.

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

It was documented under https://jekyllrb.com/docs/windows/#timezone-management but seems to have lost the ref tag..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was documented under https://jekyllrb.com/docs/windows/#timezone-management but seems to have lost the ref tag..

/cc @DirtyF Please fix on master

Copy link
Contributor Author

@KeJunMao KeJunMao Jun 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ashmaroli

Change to: ?

auto-regeneration

Although jekyll would suggest:

Please add the following to your Gemfile to avoid polling for changes:
    gem 'wdm', '>= 0.1.0' if Gem.win_platform?

Auto-regeneration will work fine without including gem 'wdm'

time-zone

Though tzinfo-data is required, you don't have to install it separately.
It is already included in a new Gemfile generated by jekyll new from v3.4.0 For sites generated with older versions, they should add it to their Gemfile.

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

Copy link
Member

@ashmaroli ashmaroli Jun 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KeJunMao I missed to point out that the user will have to run bundle install after they update their Gemfile.
But since this entire section on Timezone Management is already documented under /docs/windows/#timezone-management, simply link to that section.

(The link is currently broken. Will be fixed by maintainers separately)

Copy link
Contributor Author

@KeJunMao KeJunMao Jun 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ashmaroli

Change to: ?

auto-regeneration

Although jekyll would suggest:

Please add the following to your Gemfile to avoid polling for changes:
    gem 'wdm', '>= 0.1.0' if Gem.win_platform?

Auto-regeneration will work fine without including gem 'wdm'

time-zone

Though tzinfo-data is required, you don't have to install it separately.
It is already included in a new Gemfile generated by jekyll new from v3.4.0 For sites generated with older versions, they should add it to their Gemfile,then run the bundle install.

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

More about timezone-management see here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would leave out the entire section, but let others weigh in on this..

```