8000 windows 10 tutorial by HenryKobin · Pull Request #6100 · jekyll/jekyll · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

windows 10 tutorial #6100

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
Merged
merged 9 commits into from
May 31, 2017
Merged

windows 10 tutorial #6100

merged 9 commits into from
May 31, 2017

Conversation

HenryKobin
Copy link
Contributor
@HenryKobin HenryKobin commented May 29, 2017 •
edited
Loading

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 and others added 2 commits May 29, 2017 01:39
@HenryKobin
initial commit
b7de0c0 
Added a tutorial on getting jekyll working on Windows 10 Creators Update
via Bash.
@HenryKobin
Merge pull request #1 from HenryKobin/windows-tutorial
8c27db9 
Windows 10 Tutorial
@pathawks
Copy link
Member

/cc: @jekyll/documentation

@jekyllbot jekyllbot self-assigned this May 29, 2017
@DirtyF DirtyF added windows Related to the Windows platform documentation labels May 29, 2017
@DirtyF DirtyF self-requested a review May 29, 2017 21:10
@DirtyF DirtyF assigned DirtyF and unassigned jekyllbot May 29, 2017
@tomjoht
Copy link
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
Copy link
Contributor Author

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
Copy link
Member
DirtyF commented May 30, 2017

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

/cc @jekyll/windows for feedback

DirtyF
DirtyF requested changes May 30, 2017
View reviewed changes
docs/_docs/windows.md Outdated
sudo apt-get install ruby2.3 ruby2.3-dev build-essentials
```

Or you can install an old version of ruby (1.9.3).
Copy link
Member

Choose a reason for hiding this comment

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

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

@HenryKobin
updated windows.md
29956a8 
removed section about older version of Ruby on Windows
HenryKobin
HenryKobin commented May 30, 2017
View reviewed changes
Copy link
Contributor Author
@HenryKobin HenryKobin left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Corrected!
/cc @jekyll/windows

DirtyF
DirtyF approved these changes May 30, 2017
View reviewed changes
Copy link
Member
@DirtyF DirtyF left a comment

Choose a reason for hiding this comment

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

LGTM

@DirtyF DirtyF removed their assignment May 30, 2017
ghost
ghost suggested changes May 31, 2017
View reviewed changes
Copy link
@ghost ghost left a comment

Choose a reason for hiding this comment

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

couple of minor nits

10000
docs/_docs/windows.md Outdated
```


**And thats it!**
Copy link

Choose a reason for hiding this comment

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

that's

docs/_docs/windows.md Outdated


**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.
Copy link

Choose a reason for hiding this comment

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

cd should be cd imo

Copy link

Choose a reason for hiding this comment

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

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

docs/_docs/windows.md Outdated
*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/):
Copy link

Choose a reason for hiding this comment

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

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

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

Choose a reason for hiding this comment

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

let's

docs/_docs/windows.md Outdated
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.
Copy link

Choose a reason for hiding this comment

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

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

docs/_docs/windows.md Outdated

*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:
Copy link

Choose a reason for hiding this comment

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

let's

@ashmaroli
Copy link
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! 😃

@HenryKobin
updated windows.md
86f2912 
corrected several grammar errors, and clarified some portions.
HenryKobin
HenryKobin commented May 31, 2017
View reviewed changes
Copy link
Contributor Author
@HenryKobin HenryKobin left a comment

Choose a reason for hiding this comment

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

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

@HenryKobin
Copy link
Contributor Author

@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

@DirtyF
Copy link
Member
DirtyF commented May 31, 2017 •
edited
Loading

Thanks @HenryKobin great addition for Windows users 🐚

@DirtyF
Copy link
Member
DirtyF commented May 31, 2017

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit b8430df into jekyll:master May 31, 2017
jekyllbot added a commit that referenced this pull request May 31, 2017
@jekyllbot
Update history to reflect merge of #6100 [ci skip]
59db714
@DirtyF DirtyF assigned DirtyF and unassigned parkr May 31, 2017
This was referenced Jun 1, 2017
Merged
Merged
@ericleong ericleong mentioned this pull request Jun 9, 2017
Merged
@jekyll jekyll locked and limited conversation to collaborators Jul 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@DirtyF DirtyF DirtyF approved these changes

Assignees

@DirtyF DirtyF

Labels
frozen-due-to-age windows Related to the Windows platform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@HenryKobin @pathawks @tomjoht @DirtyF @ashmaroli @parkr @jekyllbot
0