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

corrected windows.md #6149

Merged
merged 6 commits into from Jun 18, 2017

Conversation

Projects
None yet
5 participants
@HenryKobin
Contributor

HenryKobin commented Jun 16, 2017

fixed some grammar issues, formatting, etc.
continued from pull(#6148).

/cc @jekyll/documentation @jekyll/windows

corrected windows.md
fixed some grammar issues, formatting, etc.
Show outdated Hide outdated docs/_docs/windows.md
@@ -81,6 +90,7 @@ the site generation process. It can be done with the following command:
```sh
$ chcp 65001
```
#### Time-Zone Management (Chocolatey method)

This comment has been minimized.

@ashmaroli

ashmaroli Jun 16, 2017

Member

Why???
Even after repeatedly saying, this is not specific to the Chocolatey method.. why???

@ashmaroli

ashmaroli Jun 16, 2017

Member

Why???
Even after repeatedly saying, this is not specific to the Chocolatey method.. why???

This comment has been minimized.

@HenryKobin

HenryKobin Jun 16, 2017

Contributor

... Did we not just discuss that it doesn't apply to RubyInstaller and Bash on Windows? I haven't tried chocolatey so I'm not going to delete a section of a tutorial if it might break the method..? Sorry?
edit: Should i delete this section entirely then? I just don't know if someone installing via Chocolatey is going to have to worry about IANA timezones ( tz variable defaulting to UTC/GMT 00:00)

@HenryKobin

HenryKobin Jun 16, 2017

Contributor

... Did we not just discuss that it doesn't apply to RubyInstaller and Bash on Windows? I haven't tried chocolatey so I'm not going to delete a section of a tutorial if it might break the method..? Sorry?
edit: Should i delete this section entirely then? I just don't know if someone installing via Chocolatey is going to have to worry about IANA timezones ( tz variable defaulting to UTC/GMT 00:00)

This comment has been minimized.

@HenryKobin

HenryKobin Jun 16, 2017

Contributor

@ashmaroli I moved it outside of the Chocolatey installation directions, so it has it's own section. I just can't decide if it makes more sense at the very end of the page, or the beginning, or what. I just thought since each tutorial had it's own mention of Time-Zone management and auto regeneration, that would be the make the most sense organizationally.

@HenryKobin

HenryKobin Jun 16, 2017

Contributor

@ashmaroli I moved it outside of the Chocolatey installation directions, so it has it's own section. I just can't decide if it makes more sense at the very end of the page, or the beginning, or what. I just thought since each tutorial had it's own mention of Time-Zone management and auto regeneration, that would be the make the most sense organizationally.

HenryKobin added some commits Jun 16, 2017

moved timezone management info
moved Time-Zone management header out of Chocolatey installation directions, since it applies to all install variations.
moved headers windows.md
moved auto regeneration and time-zone management to the bottom of page, and removed them from each tutorial since they (potentially) apply to all install methods.
fixed typo
moved auto regeneration and time-zone management to the bottom of the page. These sections may apply to any installation method.
@HenryKobin

This comment has been minimized.

Show comment
Hide comment
@HenryKobin

HenryKobin Jun 16, 2017

Contributor

@ashmaroli I moved the Time-Zone management and Auto Regeneration headers to the bottom of the page, and removed them individually from the Chocolatey and RubyInstaller sections. My main concern was more with reformatting the installation directions that already existed, more than changing anyone's tutorials around. I just did not want to leave a dangling header on the bottom of the page, etc.

Contributor

HenryKobin commented Jun 16, 2017

@ashmaroli I moved the Time-Zone management and Auto Regeneration headers to the bottom of the page, and removed them individually from the Chocolatey and RubyInstaller sections. My main concern was more with reformatting the installation directions that already existed, more than changing anyone's tutorials around. I just did not want to leave a dangling header on the bottom of the page, etc.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jun 16, 2017

Member

To make things clearer..

. Chocolatey BASH on Windows RubyInstaller
Timezone Mangement I don't know Does not require tzinfo-data gem Requires tzinfo-data gem
Regeneration I don't know Does not require wdm gem Does not require wdm
Member

ashmaroli commented Jun 16, 2017

To make things clearer..

. Chocolatey BASH on Windows RubyInstaller
Timezone Mangement I don't know Does not require tzinfo-data gem Requires tzinfo-data gem
Regeneration I don't know Does not require wdm gem Does not require wdm
@HenryKobin

This comment has been minimized.

Show comment
Hide comment
@HenryKobin

HenryKobin Jun 16, 2017

Contributor

I think the confusion is this: I got the auto-regeneration and time-zone management tutorials from the Chocolatey tutorial. That's why I left them in the chocolatey tutorial section. I also don't know about Chocolatey, but I do know this: Whoever made the Chocolatey tutorial suggested to do those things mentioned. Whoever wrote the RubyInstaller method simply wrote that regeneration worked and made a header linking to time-zone management docs.
Thats why I had nothing listed for bash on windows, a subheader in Chocolatey for Regen and TZ, and then left the RubyInstaller method how the person wrote it, simply adding a sentence under Time-Zone management instead of having the page end with a header link abruptly. @ashmaroli
edit: I think how we have it now might be good, would you mind checking out my latest commit?

Contributor

HenryKobin commented Jun 16, 2017

I think the confusion is this: I got the auto-regeneration and time-zone management tutorials from the Chocolatey tutorial. That's why I left them in the chocolatey tutorial section. I also don't know about Chocolatey, but I do know this: Whoever made the Chocolatey tutorial suggested to do those things mentioned. Whoever wrote the RubyInstaller method simply wrote that regeneration worked and made a header linking to time-zone management docs.
Thats why I had nothing listed for bash on windows, a subheader in Chocolatey for Regen and TZ, and then left the RubyInstaller method how the person wrote it, simply adding a sentence under Time-Zone management instead of having the page end with a header link abruptly. @ashmaroli
edit: I think how we have it now might be good, would you mind checking out my latest commit?

Show outdated Hide outdated docs/_docs/windows.md
gem 'wdm', '~> 0.1.0' if Gem.win_platform?
```
```

This comment has been minimized.

@pathawks

pathawks Jun 16, 2017

Member

Probably didn't mean for this to be here?

@pathawks

pathawks Jun 16, 2017

Member

Probably didn't mean for this to be here?

This comment has been minimized.

@HenryKobin

HenryKobin Jun 16, 2017

Contributor

@pathawks it's odd because when I click edit on my end, line 200 doesn't exist. I made another commit, hopefully it's gone for real this time.

@HenryKobin

HenryKobin Jun 16, 2017

Contributor

@pathawks it's odd because when I click edit on my end, line 200 doesn't exist. I made another commit, hopefully it's gone for real this time.

corrected typo on windows.md
corrected typo on windows.md that wasn't showing on my end initially
@HenryKobin

This comment has been minimized.

Show comment
Hide comment
@HenryKobin

HenryKobin Jun 18, 2017

Contributor

@pathawks would you mind double checking the latest commit? I think that the final line with the backticks was a bug or something.

Contributor

HenryKobin commented Jun 18, 2017

@pathawks would you mind double checking the latest commit? I think that the final line with the backticks was a bug or something.

@DirtyF

DirtyF approved these changes Jun 18, 2017

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jun 18, 2017

Member

@ashmarol as you're member of @jekyll/windows waiting for your approval before merging this.

Member

DirtyF commented Jun 18, 2017

@ashmarol as you're member of @jekyll/windows waiting for your approval before merging this.

@ashmaroli

requesting a few minor corrections.. Thanks

@@ -42,16 +43,24 @@ Now all that is left to do is install Jekyll.
sudo gem install jekyll bundler
```
You can test by running:
Check to see if your installation worked.

This comment has been minimized.

@ashmaroli

ashmaroli Jun 18, 2017

Member

Prefer rewording to To check if Jekyll installed properly, run the following:
But I'll leave it to your judgement.

@ashmaroli

ashmaroli Jun 18, 2017

Member

Prefer rewording to To check if Jekyll installed properly, run the following:
But I'll leave it to your judgement.

```
replacing `my_project` with the name of your website.
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.

@ashmaroli

ashmaroli Jun 18, 2017

Member

instead of broken sentences, you could write it as:


To start a new project named my_project simply run:

$ jekyll new my_product

@ashmaroli

ashmaroli Jun 18, 2017

Member

instead of broken sentences, you could write it as:


To start a new project named my_project simply run:

$ jekyll new my_product

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

This comment has been minimized.

@ashmaroli

ashmaroli Jun 18, 2017

Member

Unnecessary additional white space at the end here

@ashmaroli

ashmaroli Jun 18, 2017

Member

Unnecessary additional white space at the end here

@@ -12,7 +12,8 @@ For older installations, this page aims to collect some of the general knowledge
*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 let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
First let's make sure all our packages / repositories are up to date.

This comment has been minimized.

@ashmaroli

ashmaroli Jun 18, 2017

Member

This change is unnecessary per se as this line break won't be rendered by Kramdown. There is a a lot of inconsistency with respect to this in the entirety of our docs. I prefer handling that in a separate PR.

@ashmaroli

ashmaroli Jun 18, 2017

Member

This change is unnecessary per se as this line break won't be rendered by Kramdown. There is a a lot of inconsistency with respect to this in the entirety of our docs. I prefer handling that in a separate PR.

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jun 18, 2017

Member

@ashmaroli thanks for the review, as long as there is no false information, I'll merge this first version. Feel free to enhance in another PR as you suggested.

@HenryKobin Thanks you for enhancing Jekyll's documentation 👍

@jekyllbot: merge +docs

Member

DirtyF commented Jun 18, 2017

@ashmaroli thanks for the review, as long as there is no false information, I'll merge this first version. Feel free to enhance in another PR as you suggested.

@HenryKobin Thanks you for enhancing Jekyll's documentation 👍

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit 5ceef94 into jekyll:master Jun 18, 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 18, 2017

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jun 18, 2017

Member

Will open a PR then..

Member

ashmaroli commented Jun 18, 2017

Will open a PR then..

@HenryKobin HenryKobin deleted the HenryKobin:patch-4 branch Jun 18, 2017

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