Skip to content
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 Versioning Support #884

Merged
merged 7 commits into from
Aug 22, 2019
Merged

Docs Versioning Support #884

merged 7 commits into from
Aug 22, 2019

Conversation

KDr2
Copy link
Member

@KDr2 KDr2 commented Aug 9, 2019

See #837.

Ready to merge.

@KDr2 KDr2 force-pushed the docs-versioning branch from 268ef52 to e883e1c Compare August 9, 2019 08:27
@KDr2 KDr2 force-pushed the docs-versioning branch 5 times, most recently from 8ee83e2 to cc30f79 Compare August 12, 2019 08:24
Copy link
Member Author

@KDr2 KDr2 left a comment

Choose a reason for hiding this comment

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

This commit should be removed begore merge.

@yebai
Copy link
Member

yebai commented Aug 12, 2019

Thanks, @KDr2! I cloned the repo so that we can preview the changes. The live preview can be found at https://yebai.github.io/Turing.jl/dev/

It appears that

@KDr2
Copy link
Member Author

KDr2 commented Aug 13, 2019

Hi @yebai the error is caused by the context path (i.e. the base url).

The baseurl is set while compiling pages with Jekyll. for the dev version, it's /dev, for the tagged version, it's /vN.M.

In your case, the baseurl is /Turing.jl/dev/, not /dev. You can create a new CNAME record, for example, testing.turing.ml to test it.

@KDr2 KDr2 force-pushed the docs-versioning branch from cc30f79 to bfaf98a Compare August 14, 2019 02:16
@KDr2
Copy link
Member Author

KDr2 commented Aug 14, 2019

@yebai I've found the paths issues were caused by a glitch of Jekyll's baseurl on Travis ENV. It is fixed now.

I set up a test site, on my forked repo:

Please have a look.

@KDr2 KDr2 force-pushed the docs-versioning branch 2 times, most recently from 13428c6 to b58257d Compare August 20, 2019 09:16
@KDr2 KDr2 force-pushed the docs-versioning branch from b58257d to 24770c9 Compare August 21, 2019 01:26
@KDr2 KDr2 changed the title [WIP] Docs Versioning Support Docs Versioning Support Aug 21, 2019
@KDr2 KDr2 requested a review from yebai August 21, 2019 01:41
@KDr2 KDr2 changed the title Docs Versioning Support [WIP] Docs Versioning Support Aug 21, 2019
@KDr2 KDr2 force-pushed the docs-versioning branch from 3a49807 to 3cdb0cf Compare August 21, 2019 07:30
@yebai
Copy link
Member

yebai commented Aug 21, 2019

Thanks, @KDr2. It looks good to me except that the dropdown menu for version switch is empty. It might be tricky to include older versions of doc since they are based on a different template, but maybe includes the last release (i.e. v0.6.23, which is based on the new template) together with dev?

@yebai yebai requested a review from cpfiffer August 21, 2019 11:56
@yebai yebai changed the title [WIP] Docs Versioning Support Docs Versioning Support Aug 21, 2019
@cpfiffer
Copy link
Member

I might also change the font size of the class md-header-nav__source to 1.4rem instead of 1rem, because it's a very small dropdown.

Copy link
Member

@cpfiffer cpfiffer left a comment

Choose a reason for hiding this comment

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

Really well done, thanks for fixing some of my weird pre- and post- processing code.

@KDr2
Copy link
Member Author

KDr2 commented Aug 22, 2019

includes the last release (i.e. v0.6.23, which is based on the new template) together with dev?

Done, please check:

@yebai yebai merged commit 907b152 into master Aug 22, 2019
@delete-merged-branch delete-merged-branch bot deleted the docs-versioning branch August 22, 2019 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants