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.

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

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

Merged
merged 4 commits into from Jun 16, 2017

Conversation

Projects
None yet
6 participants
@KeJunMao
Contributor

KeJunMao commented Jun 15, 2017

Installation via RubyInstaller

docs(JekyllOnWindows): Add a new Installation way
Installation via RubyInstaller
@HenryKobin

This comment has been minimized.

Show comment
Hide comment
@HenryKobin

HenryKobin Jun 15, 2017

Contributor

/cc: @jekyllbot @jekyll/documentation

By chance have you tested auto-regeneration or time-zone management to see if they are functional if you install via this method?

Contributor

HenryKobin commented Jun 15, 2017

/cc: @jekyllbot @jekyll/documentation

By chance have you tested auto-regeneration or time-zone management to see if they are functional if you install via this method?

Show outdated Hide outdated docs/_docs/windows.md
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`

This comment has been minimized.

@ashmaroli

ashmaroli Jun 15, 2017

Member

I haven't tried the latest version from RubyInstaller2, but does the Installer itself have an environment to accept shell commands?
I feel L#180 and L#181 should rather be:

2. Install Jekyll and Bundler via a command prompt window: `gem install jekyll bundler`
3. Check if the installation is accessible: `jekyll -v`
@ashmaroli

ashmaroli Jun 15, 2017

Member

I haven't tried the latest version from RubyInstaller2, but does the Installer itself have an environment to accept shell commands?
I feel L#180 and L#181 should rather be:

2. Install Jekyll and Bundler via a command prompt window: `gem install jekyll bundler`
3. Check if the installation is accessible: `jekyll -v`
@KeJunMao

This comment has been minimized.

Show comment
Hide comment
@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@HenryKobin

Yes!

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?

But auto-regeneration still works fine.

timezone

Requires two gems:

gem install tzinfo
gem install tzinfo-data
Contributor

KeJunMao commented Jun 15, 2017

@HenryKobin

Yes!

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?

But auto-regeneration still works fine.

timezone

Requires two gems:

gem install tzinfo
gem install tzinfo-data
@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jun 15, 2017

Member

Requires two gems:

No, actually, only requires tzinfo-data. tzinfo is automatically included with the former.

Member

ashmaroli commented Jun 15, 2017

Requires two gems:

No, actually, only requires tzinfo-data. tzinfo is automatically included with the former.

@HenryKobin

This comment has been minimized.

Show comment
Hide comment
@HenryKobin

HenryKobin Jun 15, 2017

Contributor

@KeJunMao Could you add that part about time-zone management and auto-regeneration to the end of your tutorial, please? Thank you, by the way! 👍
edit: Or at least add the part about Time-Zone management needing a plugin, and just let the user know they can ignore the warning about regeneration.

Contributor

HenryKobin commented Jun 15, 2017

@KeJunMao Could you add that part about time-zone management and auto-regeneration to the end of your tutorial, please? Thank you, by the way! 👍
edit: Or at least add the part about Time-Zone management needing a plugin, and just let the user know they can ignore the warning about regeneration.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jun 15, 2017

Member

Note: gem 'wdm' is not actually required for regeneration to work on Windows. Its an outdated warning IMO,

Member

ashmaroli commented Jun 15, 2017

Note: gem 'wdm' is not actually required for regeneration to work on Windows. Its an outdated warning IMO,

docs(windows): update Installation via RubyInstaller
add about auto-regeneration and time-zone
@KeJunMao

This comment has been minimized.

Show comment
Hide comment
@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@HenryKobin Thanks!

Contributor

KeJunMao commented Jun 15, 2017

@HenryKobin Thanks!

Show outdated Hide outdated docs/_docs/windows.md
```
But auto-regeneration still works fine.Its an outdated warning IMO.

This comment has been minimized.

@ashmaroli

ashmaroli Jun 15, 2017

Member

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

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

ashmaroli Jun 15, 2017

Member

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

Auto-regeneration will work fine without including `gem 'wdm'`
Show outdated Hide outdated docs/_docs/windows.md
Requires one gem:
```shell
gem install tzinfo-data

This comment has been minimized.

@ashmaroli

ashmaroli Jun 15, 2017

Member

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..

@ashmaroli

ashmaroli Jun 15, 2017

Member

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..

This comment has been minimized.

@ashmaroli

ashmaroli Jun 15, 2017

Member

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

@ashmaroli

ashmaroli Jun 15, 2017

Member

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

This comment has been minimized.

@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@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]
@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@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]

This comment has been minimized.

@ashmaroli

ashmaroli Jun 15, 2017

Member

@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)

@ashmaroli

ashmaroli Jun 15, 2017

Member

@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)

This comment has been minimized.

@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@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.

@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@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.

This comment has been minimized.

@ashmaroli

ashmaroli Jun 15, 2017

Member

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

@ashmaroli

ashmaroli Jun 15, 2017

Member

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

@parkr

Just a few super minor changes requested. Thank you!!

Show outdated Hide outdated docs/_docs/windows.md
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)

This comment has been minimized.

@parkr

parkr Jun 15, 2017

Member

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

@parkr

parkr Jun 15, 2017

Member

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

Show outdated Hide outdated docs/_docs/windows.md
see [Autoinstall Jekyll for windows](https://github.com/KeJunMao/fastjekyll#autoinstall-jekyll-for-windows)
### auto-regeneration

This comment has been minimized.

@parkr

parkr Jun 15, 2017

Member

Capital A here, please.

@parkr

parkr Jun 15, 2017

Member

Capital A here, please.

Auto-regeneration will work fine without including `gem 'wdm'`
### [time-zone](/docs/windows/#timezone-management)

This comment has been minimized.

@parkr

parkr Jun 15, 2017

Member

Did you want to elaborate on this at all or just head a dangling header?

@parkr

parkr Jun 15, 2017

Member

Did you want to elaborate on this at all or just head a dangling header?

This comment has been minimized.

@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@parkr
edit:
I just want to dangling a header.So what should i have to do.

@KeJunMao

KeJunMao Jun 15, 2017

Contributor

@parkr
edit:
I just want to dangling a header.So what should i have to do.

This comment has been minimized.

@KeJunMao

KeJunMao Jun 15, 2017

Contributor

Or :

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.

@KeJunMao

KeJunMao Jun 15, 2017

Contributor

Or :

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.

@parkr

parkr approved these changes Jun 16, 2017

@oe

oe approved these changes Jun 16, 2017

@oe

This comment has been minimized.

Show comment
Hide comment
@oe

oe Jun 16, 2017

Member

@jekyllbot: merge +docs

Member

oe commented Jun 16, 2017

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit 8dd76bc into jekyll:master Jun 16, 2017

1 of 2 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

jekyllbot added a commit that referenced this pull request Jun 16, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment