Skip to content

Separate turing.ml site from Turing.jl #4

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

Merged
merged 50 commits into from
Nov 5, 2020
Merged

Conversation

cpfiffer
Copy link
Member

@cpfiffer cpfiffer commented Nov 1, 2020

This PR makes it so that the build process for turing.ml is distinct from Turing.jl. Currently, all the website files live inside Turing's docs folder, which has various disadvantages.

Most of the work in the PR shows up in make.jl and a little bit in make-utils.jl. Everything else is largely copied over from Turing.jl/docs. To summarize the new build process:

  1. Each time a commit shows up on this repo or on the 23rd hour of every day, a GitHub Action is triggered.
  2. The GH action builds the current master of Turing, and then rebuilds whatever the most recent released version is.
  3. During the build process, make.jl will build the site in a temporary folder and copy all the relevant documents to it. Documenter.jl deploys the docs from this temporary folder.

The idea is to keep everything that needs to be "stateful" in Turing.jl, such as the guides and documentation, and everything that always needs to be current (like the blog or list of team members) in this repo. We also don't really want to have much/any HTML in Turing.jl, which this PR also handles. I will remove all the stuff we don't need in Turing once this repo is functional.

Note that this won't actually change the site when the PR goes through, since GitHub is still configured to serve the site from Turing.jl. I assume there will also be some headaches as we transition over, but I won't know until we merge this in.


highest = maximum(highest_tags(versions))
@info "" baseurl
Copy link
Member

Choose a reason for hiding this comment

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

Maybe @debug instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

Well, I'd rather be able to see it in the build logs without setting any other environment variables. It's pretty rare that this would be run by a human.

@yebai
Copy link
Member

yebai commented Nov 3, 2020

The idea is to keep everything that needs to be "stateful" in Turing.jl, such as the guides and documentation, and everything that always needs to be current (like the blog or list of team members) in this repo.

Seconded - this looks like a sensible separation between docs (Turing.jl and related libraries) and website (appearance, blog, news etc.).

Note that this won't actually change the site when the PR goes through, since GitHub is still configured to serve the site from Turing.jl. I assume there will also be some headaches as we transition over, but I won't know until we merge this in.

To clarify a bit: does this mean the resulting output is pushed to the gh-pages branch of Turing.jl?

Copy link
Member

@yebai yebai left a comment

Choose a reason for hiding this comment

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

Great work - thanks @cpfiffer! I left two minor questions in the comments section.

@cpfiffer
Copy link
Member Author

cpfiffer commented Nov 3, 2020

To clarify a bit: does this mean the resulting output is pushed to the gh-pages branch of Turing.jl?

Not quite. Both TuringLang/turing.ml and TuringLang/Turing.jl have a gh-pages branch, and each are currently spitting out documentation to their respective branches. Eventually we want to shut down the Turing.jl:gh-pages branch and redirect GitHub Pages to this repository instead.

@yebai yebai merged commit 04a2605 into TuringLang:master Nov 5, 2020
shravanngoswamii pushed a commit that referenced this pull request Apr 14, 2025
* improve colors

* better link hover color
shravanngoswamii pushed a commit that referenced this pull request Apr 21, 2025
* improve colors

* better link hover color
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