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

windows 10 tutorial #6100

Merged
merged 9 commits into from May 31, 2017

Conversation

Projects
None yet
8 participants
@HenryKobin
Contributor

HenryKobin commented May 29, 2017

Hey guys! I got jekyll running flawlessly on my copy of windows 10 creators update with some pretty basic steps taken. I was curious if I could contribute this guide to the docs. Thanks for your time, let me know if you want me to edit anything / reformat the markdown.

/cc @parkr @jekyllbot

HenryKobin added some commits May 29, 2017

initial commit
Added a tutorial on getting jekyll working on Windows 10 Creators Update
via Bash.
@pathawks

This comment has been minimized.

Show comment
Hide comment
Member

pathawks commented May 29, 2017

@jekyllbot jekyllbot self-assigned this May 29, 2017

@DirtyF DirtyF self-requested a review May 29, 2017

@DirtyF DirtyF assigned DirtyF and unassigned jekyllbot May 29, 2017

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht May 30, 2017

Contributor

Henry, thanks for writing out this installation doc. I think it would fit better on the Jekyll on Windows page rather than in Tutorials.

Also, how do the rest of the Windows instructions fit in with your Windows 10 section? Do you still have to complete the other Windows-related tasks such as Time Zone Management or Auto-regeneration? Does the Chocolately tutorial still work on Win 10? In short, can you integrate this info more seamlessly into the larger Windows documentation (on that page)?

Contributor

tomjoht commented May 30, 2017

Henry, thanks for writing out this installation doc. I think it would fit better on the Jekyll on Windows page rather than in Tutorials.

Also, how do the rest of the Windows instructions fit in with your Windows 10 section? Do you still have to complete the other Windows-related tasks such as Time Zone Management or Auto-regeneration? Does the Chocolately tutorial still work on Win 10? In short, can you integrate this info more seamlessly into the larger Windows documentation (on that page)?

@HenryKobin

This comment has been minimized.

Show comment
Hide comment
@HenryKobin

HenryKobin May 30, 2017

Contributor

Thanks for the response @tomjohnson1492. I agree it would probably fit better on that page. Auto-Regeneration is working fine, although the error message still displays as a warning. I'll have to double check time-zone management, but my files were formatting with the current time/date when I create a new project.
I am not sure about the Chocolately method, I used Bash so I never had to try. I can certainly double check this. Let me get back to you guys in the next 24 hours with a version of the Jekyll on Windows page.
Should I create a new pull request when I finish or just continue this one?

Contributor

HenryKobin commented May 30, 2017

Thanks for the response @tomjohnson1492. I agree it would probably fit better on that page. Auto-Regeneration is working fine, although the error message still displays as a warning. I'll have to double check time-zone management, but my files were formatting with the current time/date when I create a new project.
I am not sure about the Chocolately method, I used Bash so I never had to try. I can certainly double check this. Let me get back to you guys in the next 24 hours with a version of the Jekyll on Windows page.
Should I create a new pull request when I finish or just continue this one?

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF May 30, 2017

Member

@HenryKobin There is no need to create another PR, just continue here.

/cc @jekyll/windows for feedback

Member

DirtyF commented May 30, 2017

@HenryKobin There is no need to create another PR, just continue here.

/cc @jekyll/windows for feedback

HenryKobin added some commits May 30, 2017

Moved from tutorial to windows page
Removed tutorial/link to tutorial, added to windows docs
updated windows.md
added line for how to test.
Show outdated Hide outdated docs/_docs/windows.md
sudo apt-get install ruby2.3 ruby2.3-dev build-essentials
```
Or you can install an old version of ruby (1.9.3).

This comment has been minimized.

@DirtyF

DirtyF May 30, 2017

Member

I wouldn't mention this, Jekyll requires Ruby > 2.0

@DirtyF

DirtyF May 30, 2017

Member

I wouldn't mention this, Jekyll requires Ruby > 2.0

updated windows.md
removed section about older version of Ruby on Windows
@HenryKobin

Corrected!
/cc @jekyll/windows

@DirtyF

DirtyF approved these changes May 30, 2017

LGTM

@DirtyF DirtyF removed their assignment May 30, 2017

@oe

couple of minor nits

Show outdated Hide outdated docs/_docs/windows.md
```
**And thats it!**

This comment has been minimized.

@oe

oe May 31, 2017

Member

that's

@oe

oe May 31, 2017

Member

that's

Show outdated Hide outdated docs/_docs/windows.md
**And thats it!**
If you cd into the folder, you can make sure time management is working by opening your "_posts"_ folder. You should see a markdown file with the current date listed.

This comment has been minimized.

@oe

oe May 31, 2017

Member

cd should be cd imo

@oe

oe May 31, 2017

Member

cd should be cd imo

This comment has been minimized.

@oe

oe May 31, 2017

Member

"_posts"_ is probably the wrong markup for this? consider using backticks here

@oe

oe May 31, 2017

Member

"_posts"_ is probably the wrong markup for this? consider using backticks here

Show outdated Hide outdated docs/_docs/windows.md
*Please note* Bash on Ubuntu on Windows is still under development, so you may run into issues. If you see an Auto-Regeneration error warning in your Bash instance, you can ignore it.
## Installation via Chocolatey
A quick way to install Jekyll is to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/):

This comment has been minimized.

@oe

oe May 31, 2017

Member

maybe amend this to say A quick way to install Jekyll using Chocolatey is [...]?

@oe

oe May 31, 2017

Member

maybe amend this to say A quick way to install Jekyll using Chocolatey is [...]?

Show outdated Hide outdated docs/_docs/windows.md
sudo apt-get update
sudo apt-get install ruby2.3 ruby2.3-dev build-essentials
```
Next lets update our Ruby gems:

This comment has been minimized.

@oe

oe May 31, 2017

Member

let's

@oe

oe May 31, 2017

Member

let's

Show outdated Hide outdated docs/_docs/windows.md
sudo apt-get update -y && sudo apt-get upgrade -y
```
Now we can install Ruby. First we need to add the repository list from BrightBox.

This comment has been minimized.

@oe

oe May 31, 2017

Member

could you provide a link here? i could see folks getting sceptical at just adding a PPA with no real context attached to it

@oe

oe May 31, 2017

Member

could you provide a link here? i could see folks getting sceptical at just adding a PPA with no real context attached to it

Show outdated Hide outdated docs/_docs/windows.md
*Please note:* You must have [Bash on Ubuntu on Windows](https://msdn.microsoft.com/en-us/commandline/wsl/about?f=255&MSPPError=-2147217396) enabled.
First lets make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:

This comment has been minimized.

@oe

oe May 31, 2017

Member

let's

@oe

oe May 31, 2017

Member

let's

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli May 31, 2017

Member

@HenryKobin can you also test if TimeZone Management is fine during the build process on the subsystem..? I mean, say the _config.yml contains timezone: America/New_York Does the date and time change accordingly on your HTML files in the _site folder?
Thanks! 😃

Member

ashmaroli commented May 31, 2017

@HenryKobin can you also test if TimeZone Management is fine during the build process on the subsystem..? I mean, say the _config.yml contains timezone: America/New_York Does the date and time change accordingly on your HTML files in the _site folder?
Thanks! 😃

updated windows.md
corrected several grammar errors, and clarified some portions.
@HenryKobin

Corrected several errors. Also, timezone management via the config file works totally fine. It updates the HTML.

@HenryKobin

This comment has been minimized.

Show comment
Hide comment
@HenryKobin

HenryKobin May 31, 2017

Contributor

@ashmaroli Timezone management from the config file works just fine. I tested it with America/New_York and it showed up properly via liquid templating.
@pup I corrected those errors, and removed some subheaders from the chocolatey tutorial so that it would be clear that those portions don't apply to the Bash on Ubuntu on Windows situation. I also tested Timezone via the config file, and it showed up correctly in the HTML. Also, auto-regeneration is working.
cc/ @jekyll/windows

Contributor

HenryKobin commented May 31, 2017

@ashmaroli Timezone management from the config file works just fine. I tested it with America/New_York and it showed up properly via liquid templating.
@pup I corrected those errors, and removed some subheaders from the chocolatey tutorial so that it would be clear that those portions don't apply to the Bash on Ubuntu on Windows situation. I also tested Timezone via the config file, and it showed up correctly in the HTML. Also, auto-regeneration is working.
cc/ @jekyll/windows

@oe

oe approved these changes May 31, 2017

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF May 31, 2017

Member

Thanks @HenryKobin great addition for Windows users 🐚

Member

DirtyF commented May 31, 2017

Thanks @HenryKobin great addition for Windows users 🐚

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF May 31, 2017

Member

@jekyllbot: merge +docs

Member

DirtyF commented May 31, 2017

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit b8430df into jekyll:master May 31, 2017

2 checks passed

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

jekyllbot added a commit that referenced this pull request May 31, 2017

@DirtyF DirtyF assigned DirtyF and unassigned parkr May 31, 2017

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