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

Documentation on how to build navigation #5698

Merged
merged 11 commits into from Feb 28, 2017

Conversation

Projects
None yet
7 participants
@tomjoht
Contributor

tomjoht commented Dec 27, 2016

I added a documentation page on how to build navigation for your site. This topic is primarily intended for users who have a lot of pages on their site (such as for documentation websites), and want to build a more robust sidebar navigation.

Jekyll combines Liquid with YAML in interesting ways that aren't really documented clearly in the existing docs, except for a brief reference here. You can read about Liquid on Shopify and YAML in YAML's docs, but exactly how you store YAML files in a Jekyll project and iterate through them using Liquid loops and filters to generate lists of pages is something that isn't clear to a lot of people. (You can see origins of these questions in previous help issues.) The documentation on navigation would fit well into the Jekyll docs.

@jekyll/documentation

Documentation on how to build navigation
I added a documentation page on how to build navigation for your site. This topic is primarily intended for users who have a lot of pages on their site (such as for documentation websites), and want to build a more robust sidebar navigation.

Jekyll combines Liquid with YAML in interesting ways that aren't really documented clearly in the existing docs, except for a brief reference [here](http://jekyllrb.com/docs/datafiles/#the-data-folder). You can read about Liquid on Shopify and YAML in YAML's docs, but exactly how you store YAML files in a Jekyll project and iterate through them using Liquid loops and filters to generate lists of pages is something that isn't clear to a lot of people. (You can see origins of these questions in [previous help issues](jekyll/jekyll-help#266).)  The documentation on navigation would fit well into the Jekyll docs.
@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 27, 2016

Member

@DirtyF How about hosting all "how to.." stuff on another document entirely? (or a subdomain e.g. tips.jekyllrb.com?)

/cc @parkr

Member

ashmaroli commented Dec 27, 2016

@DirtyF How about hosting all "how to.." stuff on another document entirely? (or a subdomain e.g. tips.jekyllrb.com?)

/cc @parkr

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Dec 27, 2016

Contributor

Are you proposing that all documentation be moved into a subdomain? Or just some types of documentation?

If it's just some types of documentation, my suggestion is that rather than fragmenting the documentation into different domains, we instead create an Advanced page that simply lists the advanced tutorials.

I get that we probably don't want Jekyll's documentation to seem too complicated. (All product managers want their product to seem simple.) But the result is often a paradox. The more "simple" we try to make something by removing documentation, the harder it can become for people to use the product. As soon as people get passed the first step of installing Jekyll, they're confused at how to go to the next step.

The solution to providing simple instructions for novice users and advanced instructions for advanced users is to separate the info out a bit. Put the advanced content into an advanced area. This is why I proposed adding a link to the navigation document from http://jekyllrb.com/docs/datafiles/. The datafiles doc starts out easy, and when you want to do something more, you transition to more advanced info (progressive disclosure).

But maybe I'm misinterpreting the proposal here. Maybe the subdomain idea is to facilitate something else altogether, such as simplifying merge updates? Would decoupling docs from the other Jekyll code make it easier to deploy updates?

Re tips in the subdomain, there's already http://jekyll.tips/, so that wouldn't work. (Actually, I'd love to see Mike's info be merged with the existing Jekyll doc. I don't know why that's separate in the first place. His tutorials and info are golden.)

The most logical alternative for a subdomain is docs.jekyllrb.com.

Contributor

tomjoht commented Dec 27, 2016

Are you proposing that all documentation be moved into a subdomain? Or just some types of documentation?

If it's just some types of documentation, my suggestion is that rather than fragmenting the documentation into different domains, we instead create an Advanced page that simply lists the advanced tutorials.

I get that we probably don't want Jekyll's documentation to seem too complicated. (All product managers want their product to seem simple.) But the result is often a paradox. The more "simple" we try to make something by removing documentation, the harder it can become for people to use the product. As soon as people get passed the first step of installing Jekyll, they're confused at how to go to the next step.

The solution to providing simple instructions for novice users and advanced instructions for advanced users is to separate the info out a bit. Put the advanced content into an advanced area. This is why I proposed adding a link to the navigation document from http://jekyllrb.com/docs/datafiles/. The datafiles doc starts out easy, and when you want to do something more, you transition to more advanced info (progressive disclosure).

But maybe I'm misinterpreting the proposal here. Maybe the subdomain idea is to facilitate something else altogether, such as simplifying merge updates? Would decoupling docs from the other Jekyll code make it easier to deploy updates?

Re tips in the subdomain, there's already http://jekyll.tips/, so that wouldn't work. (Actually, I'd love to see Mike's info be merged with the existing Jekyll doc. I don't know why that's separate in the first place. His tutorials and info are golden.)

The most logical alternative for a subdomain is docs.jekyllrb.com.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 28, 2016

Member

What I'm proposing is that all documentation related to non-basic customization of Jekyll be moved to a separate document or subdomain ( new repo ) by itself. http://tips.jekyllrb.com was only a suggestion. In theory it will work because tips will be a subdomain of jekyllrb.com, no way related to http://jekyll.tips. But should the idea be considered, we could think of using a different subdomain entirely to avoid confusion with the latter site.

IMO, jekyllrb.com being official documentation should not disseminate tutorials.

Member

ashmaroli commented Dec 28, 2016

What I'm proposing is that all documentation related to non-basic customization of Jekyll be moved to a separate document or subdomain ( new repo ) by itself. http://tips.jekyllrb.com was only a suggestion. In theory it will work because tips will be a subdomain of jekyllrb.com, no way related to http://jekyll.tips. But should the idea be considered, we could think of using a different subdomain entirely to avoid confusion with the latter site.

IMO, jekyllrb.com being official documentation should not disseminate tutorials.

@pathawks

This comment has been minimized.

Show comment
Hide comment
@pathawks

pathawks Dec 28, 2016

Member

What I'm proposing is that all documentation related to non-basic customization of Jekyll be moved to a separate document

I disagree that making it more difficult to find or contribute to documentation would solve any problem.

Member

pathawks commented Dec 28, 2016

What I'm proposing is that all documentation related to non-basic customization of Jekyll be moved to a separate document

I disagree that making it more difficult to find or contribute to documentation would solve any problem.

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Dec 28, 2016

Contributor

I think it's a good idea to have different areas of documentation. I can see value in having a section designated for tutorials, another section designated for reference, another for getting started. And I can see how this topic on implementing navigation would fit into a tutorials section.

But as far as shifting around the different types of content onto different subdomains, I'm not a fan of that. It will make linking more difficult, as well as potentially create confusion among users.

How about just adding a link to "Tutorials" in the sidebar, and then on that page, add a link to "Implementing Navigation." Or create a _tutorials collection and put them there. Then they could be under jekyllrb.com/tutorials instead of jekyllrb.com/docs. I like that idea.

I have a few other tutorials brewing in the back of my mind. For example, implementing media RSS feeds, converting an HTML theme into a jekyll site, implementing translation, validating links, and more. All of these topics could comfortably fit into a Tutorials collection.

Really, users don't care as long as they can find the information and it answers their question. Good documentation has a mix of reference, tutorials, how-to topics, and more. Think about it -- the foundation of all developer documentation is a "Hello World" tutorial.

Contributor

tomjoht commented Dec 28, 2016

I think it's a good idea to have different areas of documentation. I can see value in having a section designated for tutorials, another section designated for reference, another for getting started. And I can see how this topic on implementing navigation would fit into a tutorials section.

But as far as shifting around the different types of content onto different subdomains, I'm not a fan of that. It will make linking more difficult, as well as potentially create confusion among users.

How about just adding a link to "Tutorials" in the sidebar, and then on that page, add a link to "Implementing Navigation." Or create a _tutorials collection and put them there. Then they could be under jekyllrb.com/tutorials instead of jekyllrb.com/docs. I like that idea.

I have a few other tutorials brewing in the back of my mind. For example, implementing media RSS feeds, converting an HTML theme into a jekyll site, implementing translation, validating links, and more. All of these topics could comfortably fit into a Tutorials collection.

Really, users don't care as long as they can find the information and it answers their question. Good documentation has a mix of reference, tutorials, how-to topics, and more. Think about it -- the foundation of all developer documentation is a "Hello World" tutorial.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 28, 2016

Member

👍 to more tutorials.. I would just like them all collected under a single dedicated document/sub-domain.
👍 to _tutorials collection folder. It addresses my point with minimal interference.

Member

ashmaroli commented Dec 28, 2016

👍 to more tutorials.. I would just like them all collected under a single dedicated document/sub-domain.
👍 to _tutorials collection folder. It addresses my point with minimal interference.

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Dec 29, 2016

Contributor

Do you want me to create the collection for this? I can. I just wasn't sure if you were waiting for me to do that.

Contributor

tomjoht commented Dec 29, 2016

Do you want me to create the collection for this? I can. I just wasn't sure if you were waiting for me to do that.

tomjoht added some commits Dec 27, 2016

Include navigation page in doc list
Include the navigation page in the sidebar doc list.
Added link to new navigation page
This just links to the new page I added about navigation.

@DirtyF DirtyF added the documentation label Jan 2, 2017

@ashmaroli
  • contents of HTML blocks, CSS and liquid blocks need to be indented consistently.
  • move styles to our sass partial.
Show outdated Hide outdated docs/_docs/navigation.md
permalink: /docs/navigation
---
<style>

This comment has been minimized.

@ashmaroli

ashmaroli Jan 2, 2017

Member

<style> blocks should be moved to an external stylesheet.. this would allow the use of same styles for future tutorials.

@ashmaroli

ashmaroli Jan 2, 2017

Member

<style> blocks should be moved to an external stylesheet.. this would allow the use of same styles for future tutorials.

This comment has been minimized.

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

Show outdated Hide outdated docs/_docs/navigation.md
<style>
.result {
border: 1px solid yellow;

This comment has been minimized.

@ashmaroli

ashmaroli Jan 2, 2017

Member

indentation required for better readability

@ashmaroli

ashmaroli Jan 2, 2017

Member

indentation required for better readability

This comment has been minimized.

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

Show outdated Hide outdated docs/_docs/navigation.md
{% raw %}<h2>{{ site.data.samplelist.docs_list_title }}</h2>
<ul>
{% for item in site.data.samplelist.docs %}
<li><a href="{{ item.url }}" alt="{{ item.title }}">{{ item.title }}</a></li>

This comment has been minimized.

@ashmaroli

ashmaroli Jan 2, 2017

Member

contents of liquid blocks are indented as well..

<ul>
  {% for item in site.data.samplelist.docs %}
    <li><a href="{{ item.url }}" alt="{{ item.title }}">{{ item.title }}</a></li>
  {% endfor %}
</ul>
@ashmaroli

ashmaroli Jan 2, 2017

Member

contents of liquid blocks are indented as well..

<ul>
  {% for item in site.data.samplelist.docs %}
    <li><a href="{{ item.url }}" alt="{{ item.title }}">{{ item.title }}</a></li>
  {% endfor %}
</ul>

This comment has been minimized.

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

Show outdated Hide outdated docs/_docs/navigation.md
<li><a href="configuration.html" alt="Configuration">Configuration</a></li>
<li><a href="deployment.html" alt="Deployment">Deployment</a></li>
</ul>
</div>

This comment has been minimized.

@ashmaroli

ashmaroli Jan 2, 2017

Member

indentation required..

@ashmaroli

ashmaroli Jan 2, 2017

Member

indentation required..

This comment has been minimized.

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

Show outdated Hide outdated docs/_docs/navigation.md
{% for item in doclist %}
<li><a href="{{ item.url }}" alt="{{ item.title }}">{{ item.title }}</a></li>
{% endfor %}{% endraw %}
```

This comment has been minimized.

@ashmaroli

ashmaroli Jan 2, 2017

Member

indentation required..

@ashmaroli

ashmaroli Jan 2, 2017

Member

indentation required..

This comment has been minimized.

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

@tomjoht

tomjoht Jan 4, 2017

Contributor

updated

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Jan 4, 2017

Contributor

I made the necessary updates around indentation. Submitting for re-review.

Contributor

tomjoht commented Jan 4, 2017

I made the necessary updates around indentation. Submitting for re-review.

Show outdated Hide outdated docs/_docs/navigation.md
<li><a href="{{ item.url }}">{{ item.title }}</a></li>
{% endfor %}
{% for item in site.data.samplelist[page.sidebar] %}
<li><a href="{{ item.url }}">{{ item.title }}</a></li>

This comment has been minimized.

@ashmaroli

ashmaroli Jan 6, 2017

Member

requires additional indentation here.. 😉

@ashmaroli

ashmaroli Jan 6, 2017

Member

requires additional indentation here.. 😉

This comment has been minimized.

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

Show outdated Hide outdated docs/_docs/navigation.md
<li class="{% if item.url == page.url %}active{% endif %}">
<a href="{{ item.url }}">{{ item.title }}</a></li>
<li class="{% if item.url == page.url %}active{% endif %}">
<a href="{{ item.url }}">{{ item.title }}</a></li>

This comment has been minimized.

@ashmaroli

ashmaroli Jan 6, 2017

Member
  • the anchor tag is nested.. so would need to be indented..
  • the closing list-item tag on a new-line..
@ashmaroli

ashmaroli Jan 6, 2017

Member
  • the anchor tag is nested.. so would need to be indented..
  • the closing list-item tag on a new-line..

This comment has been minimized.

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

Show outdated Hide outdated docs/_docs/navigation.md
**Result**
<style>

This comment has been minimized.

@ashmaroli

ashmaroli Jan 6, 2017

Member

<style> => External CSS

@ashmaroli

ashmaroli Jan 6, 2017

Member

<style> => External CSS

@DirtyF

This should cover most use cases 😅

Just a few comments.

@@ -150,3 +150,5 @@ author: dave
{% endraw %}
```

This comment has been minimized.

@DirtyF

DirtyF Jan 6, 2017

Member

I would put this in an info section:

If your Jekyll site has a lot of pages, such as with documentation websites, we got you covered with some detailed examples on [how to build robust navigation for your site](..navigation). {: .note .info }

@DirtyF

DirtyF Jan 6, 2017

Member

I would put this in an info section:

If your Jekyll site has a lot of pages, such as with documentation websites, we got you covered with some detailed examples on [how to build robust navigation for your site](..navigation). {: .note .info }

Show outdated Hide outdated docs/_docs/navigation.md
{% for cat in mydocs %}
<h2>{{ cat.name | capitalize }}</h2>
<ul>
{% assign items = cat.items | sort: 'weight' %}

This comment has been minimized.

@DirtyF

DirtyF Jan 6, 2017

Member

s/weight/order

@DirtyF

DirtyF Jan 6, 2017

Member

s/weight/order

This comment has been minimized.

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

Show outdated Hide outdated docs/_sass/_style.scss
@@ -1031,3 +1031,11 @@ code.output {
clip: rect(0, 0, 0, 0);
border: 0;
}
.result {
border: 1px solid yellow;

This comment has been minimized.

@DirtyF

DirtyF Jan 6, 2017

Member

I'd rather simply apply highlight for now. We can discuss style in a separate PR.

result-styles

@DirtyF

DirtyF Jan 6, 2017

Member

I'd rather simply apply highlight for now. We can discuss style in a separate PR.

result-styles

This comment has been minimized.

@tomjoht

tomjoht Jan 9, 2017

Contributor

Thanks for the comments. I'll make the updates in a couple of days (I'm finishing up some presentations).

@tomjoht

tomjoht Jan 9, 2017

Contributor

Thanks for the comments. I'll make the updates in a couple of days (I'm finishing up some presentations).

This comment has been minimized.

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated, but i did leave the padding style b/c without it, the text is right against the line.

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated, but i did leave the padding style b/c without it, the text is right against the line.

This comment has been minimized.

@parkr

parkr Feb 28, 2017

Member

I agree that this yellow border is a bit jarring. At the very least it needs to be the same shade of yellow that we are already using.

@parkr

parkr Feb 28, 2017

Member

I agree that this yellow border is a bit jarring. At the very least it needs to be the same shade of yellow that we are already using.

Show outdated Hide outdated docs/_docs/navigation.md
<div class="result">
<ul>
<li><a href="introduction.html">Introduction</a></li>

This comment has been minimized.

@DirtyF

DirtyF Jan 6, 2017

Member

All these clickable links will generate 404 errors 😭

Shouldn't we use # in href for all examples here?

@DirtyF

DirtyF Jan 6, 2017

Member

All these clickable links will generate 404 errors 😭

Shouldn't we use # in href for all examples here?

This comment has been minimized.

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

@tomjoht

tomjoht Jan 13, 2017

Contributor

updated

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jan 10, 2017

Member

Some more ideas:

  • Collect all tutorials under a new category: tutorials
  • Like how our release news-items are published, allow author to have their name displayed. (optional: link to their blog/website)

/cc @DirtyF, @pathawks

Member

ashmaroli commented Jan 10, 2017

Some more ideas:

  • Collect all tutorials under a new category: tutorials
  • Like how our release news-items are published, allow author to have their name displayed. (optional: link to their blog/website)

/cc @DirtyF, @pathawks

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Jan 13, 2017

Contributor

I made the updates as noted in the reviews. Submitting for review to merge. Thanks, and sorry for my delay in getting to this.

Contributor

tomjoht commented Jan 13, 2017

I made the updates as noted in the reviews. Submitting for review to merge. Thanks, and sorry for my delay in getting to this.

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Jan 15, 2017

Contributor

@ashmaroli We talked about making tutorials a collection and putting them into another section. I'm guessing I should make that change, right? This will involve me editing the config file and adding more modifications in the nav somewhere.

Contributor

tomjoht commented Jan 15, 2017

@ashmaroli We talked about making tutorials a collection and putting them into another section. I'm guessing I should make that change, right? This will involve me editing the config file and adding more modifications in the nav somewhere.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jan 15, 2017

Member

I would like that. But I'll leave the making-the-executive-decisions to @DirtyF 😃

Member

ashmaroli commented Jan 15, 2017

I would like that. But I'll leave the making-the-executive-decisions to @DirtyF 😃

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jan 17, 2017

Member

making tutorials a collection and putting them into another section. I'm guessing I should make that change

@tomjohnson1492 If you're up for it, yes! You can use a lot of the existing templates for docs, but change site.docs to site.tutorials in all the loops and where clauses and add tutorials to to the config. It may force us to re-think our top-level navigation ("HOME DOCS HELP GITHUB" etc) but for now, I think let's go for it!

Member

parkr commented Jan 17, 2017

making tutorials a collection and putting them into another section. I'm guessing I should make that change

@tomjohnson1492 If you're up for it, yes! You can use a lot of the existing templates for docs, but change site.docs to site.tutorials in all the loops and where clauses and add tutorials to to the config. It may force us to re-think our top-level navigation ("HOME DOCS HELP GITHUB" etc) but for now, I think let's go for it!

@chrisfinazzo chrisfinazzo referenced this pull request Jan 17, 2017

Closed

Retire Jekyll 2 docs #5742

amzn-tomjoht added some commits Jan 24, 2017

Added tutorials as a new collection, similar to Docs. Also added tuto…
…rial sidebar, tutorial link in primary nav, and tutorial overview page.
@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Jan 25, 2017

Contributor

I made an update here that you'll want to look at. Following @parkr's green-light, I added a new collection called tutorials and made it function similar to docs. I also added an overview page to the Tutorials section (in addition to the navigation topic that already exists). I think this section will help create a space for a wider number of community contributions -- I can already think of about 5 tutorials I want to add here.

@jekyll/documentation

Contributor

tomjoht commented Jan 25, 2017

I made an update here that you'll want to look at. Following @parkr's green-light, I added a new collection called tutorials and made it function similar to docs. I also added an overview page to the Tutorials section (in addition to the navigation topic that already exists). I think this section will help create a space for a wider number of community contributions -- I can already think of about 5 tutorials I want to add here.

@jekyll/documentation

@DirtyF

Can't wait for other tutorials 😄

Show outdated Hide outdated docs/_docs/datafiles.md
@@ -71,6 +71,9 @@ You can now render the list of members in a template:
{% endraw %}
```
{: .note .info }
If your Jekyll site has a lot of pages, such as with documentation websites, see the detailed examples in [how to build robust navigation for your site](../navigation).

This comment has been minimized.

@DirtyF

DirtyF Jan 25, 2017

Member

We need to update the link to tutorials here.

@DirtyF

DirtyF Jan 25, 2017

Member

We need to update the link to tutorials here.

This comment has been minimized.

@tomjoht

tomjoht Jan 25, 2017

Contributor

ahh, good catch. updated.

@tomjoht

tomjoht Jan 25, 2017

Contributor

ahh, good catch. updated.

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jan 25, 2017

Member

@tomjohnson1492 Shouldn't we point to the data documentation reference somewhere in the navigation tutorial?

Member

DirtyF commented Jan 25, 2017

@tomjohnson1492 Shouldn't we point to the data documentation reference somewhere in the navigation tutorial?

@DirtyF

DirtyF approved these changes Jan 25, 2017

We can haz tutorials!

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Jan 25, 2017

Contributor

I added a reference to the data files topic. Good catch there.

Contributor

tomjoht commented Jan 25, 2017

I added a reference to the data files topic. Good catch there.

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Feb 19, 2017

Contributor

Just wondering, do you happen to know when this PR will be merged? Does the merging only happen during release windows, or are merges done continuously? My other PR tutorials are dependent on this one.

Contributor

tomjoht commented Feb 19, 2017

Just wondering, do you happen to know when this PR will be merged? Does the merging only happen during release windows, or are merges done continuously? My other PR tutorials are dependent on this one.

@parkr

I had a review here from over a week ago and forgot to submit it. I'm sorry! It's not a complete review, but just some nit-picks.

@@ -2,3 +2,4 @@ _site/
*.swp
pkg/
test/
.idea/

This comment has been minimized.

@parkr

parkr Feb 28, 2017

Member

This file should be removed (we don't need a .gitignore for this subdir). At the very least this line should be removed. 😄

@parkr

parkr Feb 28, 2017

Member

This file should be removed (we don't need a .gitignore for this subdir). At the very least this line should be removed. 😄

Show outdated Hide outdated docs/_includes/primary-nav-items.html
@@ -5,6 +5,9 @@
<li class="{% if page.url contains '/docs/' %}current{% endif %}">
<a href="/docs/home/">Docs</a>
</li>
<li class="{% if page.url contains '/tutorials/' %}current{% endif %}">
<a href="/tutorials/home/">Tutorials</a>
</li>

This comment has been minimized.

@parkr

parkr Feb 28, 2017

Member

I don't believe this will fit. Perhaps it's time to revisit our hierarchy.

@parkr

parkr Feb 28, 2017

Member

I don't believe this will fit. Perhaps it's time to revisit our hierarchy.

This comment has been minimized.

@tomjoht

tomjoht Feb 28, 2017

Contributor

I could remove the "Tutorials" link from the homepage nav and list it on the "Help" page right under Documentation. Would that work?

@tomjoht

tomjoht Feb 28, 2017

Contributor

I could remove the "Tutorials" link from the homepage nav and list it on the "Help" page right under Documentation. Would that work?

This comment has been minimized.

@parkr

parkr Feb 28, 2017

Member

Yeah, that would work for now 😄

@parkr

parkr Feb 28, 2017

Member

Yeah, that would work for now 😄

Show outdated Hide outdated docs/_sass/_style.scss
@@ -1031,3 +1031,11 @@ code.output {
clip: rect(0, 0, 0, 0);
border: 0;
}
.result {
border: 1px solid yellow;

This comment has been minimized.

@parkr

parkr Feb 28, 2017

Member

I agree that this yellow border is a bit jarring. At the very least it needs to be the same shade of yellow that we are already using.

@parkr

parkr Feb 28, 2017

Member

I agree that this yellow border is a bit jarring. At the very least it needs to be the same shade of yellow that we are already using.

fixes from parkr's review. removed yellow style line. moved tutorials…
… link from primary nav to Help page. removed .giignore change.
@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Feb 28, 2017

Contributor

@parkr I made updates from your review. I moved the "Tutorials" link to the help page and removed the yellow border around the result content.

I'd really like to get this PR merged so that I can add other tutorials here as well. Let me know if I need to do anything else to speed this along. Thanks.

Contributor

tomjoht commented Feb 28, 2017

@parkr I made updates from your review. I moved the "Tutorials" link to the help page and removed the yellow border around the result content.

I'd really like to get this PR merged so that I can add other tutorials here as well. Let me know if I need to do anything else to speed this along. Thanks.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Feb 28, 2017

Member

Let's do it! Thanks 😄

@jekyllbot: merge +site

Member

parkr commented Feb 28, 2017

Let's do it! Thanks 😄

@jekyllbot: merge +site

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Feb 28, 2017

Member

We are investigating issues serving web hooks as well as assets on GitHub.com.
GitHub Status

@jekyllbot uses webhooks, WOMP. Hopefully it'll merge once the webhooks are being sent again. 😄

Member

parkr commented Feb 28, 2017

We are investigating issues serving web hooks as well as assets on GitHub.com.
GitHub Status

@jekyllbot uses webhooks, WOMP. Hopefully it'll merge once the webhooks are being sent again. 😄

@jekyllbot jekyllbot merged commit eaa2124 into jekyll:master Feb 28, 2017

1 check was pending

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details

jekyllbot added a commit that referenced this pull request Feb 28, 2017

@tomjoht

This comment has been minimized.

Show comment
Hide comment
@tomjoht

tomjoht Feb 28, 2017

Contributor

wow, that was fast. Thanks!

Contributor

tomjoht commented Feb 28, 2017

wow, that was fast. Thanks!

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