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: Fix link to SUPPORT #6415

Merged
merged 1 commit into from Oct 8, 2017

Conversation

Projects
None yet
5 participants
@DirtyF
Member

DirtyF commented Oct 5, 2017

@DirtyF DirtyF added the documentation label Oct 5, 2017

@DirtyF DirtyF requested a review from jekyll/documentation Oct 5, 2017

Show outdated Hide outdated docs/_docs/contributing.md Outdated
@oe

oe approved these changes Oct 5, 2017

@ZiroKyl

This comment has been minimized.

Show comment
Hide comment
@ZiroKyl

ZiroKyl Oct 7, 2017

Sorry, when I created my pull request ( #6416 ) I didn't see this. It contain more complex commit.

ZiroKyl commented Oct 7, 2017

Sorry, when I created my pull request ( #6416 ) I didn't see this. It contain more complex commit.

@ZiroKyl

This comment has been minimized.

Show comment
Hide comment
@ZiroKyl

ZiroKyl Oct 8, 2017

Little P.S.

#6416 commit will solve only one problem creating new ones.
If you open CONTRIBUTING.markdown in GitHub then you see [the support guidelines]({{ site.baseurl }}{% link _docs/support.md %}) instead of URI/link.

There are 3 ways:

  • more important to save the link on GitHub ➔ leave it as it was
  • more important to save the link on jekyllrb.com ➔ apply patch from #6416 commit
  • in CONTRIBUTI--ON.markdown rewrite the "link" from SUPPORT.md to ./SUPPORT.md, then in site.rake (at creating support.md) replace )[./*] to )[{{ site.baseurl }}{% link _docs/* %}]

All of them are a bad solution to the problem. Since the source files are written in the usual markdown (in GitHub) nobody can ensure referential integrity, no one except Jekyll/Liquid.

Solution:

  1. place source files in _docs/* and use {{ site.url }}{{ site.baseurl }}{% link _docs/* %} for links
  2. in site.rake: reverse data flow (from .github/* -> docs/_docs/* to docs/_docs/* -> .github/*)
  3. in site.rake: use Liquid render (w/o markdown render), i.e. docs/_docs/* --[liquid]--> .github/*

ZiroKyl commented Oct 8, 2017

Little P.S.

#6416 commit will solve only one problem creating new ones.
If you open CONTRIBUTING.markdown in GitHub then you see [the support guidelines]({{ site.baseurl }}{% link _docs/support.md %}) instead of URI/link.

There are 3 ways:

  • more important to save the link on GitHub ➔ leave it as it was
  • more important to save the link on jekyllrb.com ➔ apply patch from #6416 commit
  • in CONTRIBUTI--ON.markdown rewrite the "link" from SUPPORT.md to ./SUPPORT.md, then in site.rake (at creating support.md) replace )[./*] to )[{{ site.baseurl }}{% link _docs/* %}]

All of them are a bad solution to the problem. Since the source files are written in the usual markdown (in GitHub) nobody can ensure referential integrity, no one except Jekyll/Liquid.

Solution:

  1. place source files in _docs/* and use {{ site.url }}{{ site.baseurl }}{% link _docs/* %} for links
  2. in site.rake: reverse data flow (from .github/* -> docs/_docs/* to docs/_docs/* -> .github/*)
  3. in site.rake: use Liquid render (w/o markdown render), i.e. docs/_docs/* --[liquid]--> .github/*
Link to Support
- Generate Support page on jekyllrb.com
- Hard link to Support from Contributing page on GitHub
@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Oct 8, 2017

Member

@jekyllbot: merge +docs

Member

DirtyF commented Oct 8, 2017

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit ffc2961 into master Oct 8, 2017

1 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jekyllbot jekyllbot deleted the docs-support-link branch Oct 8, 2017

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