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

Versioning of website based on Turing's versions #478

Merged
merged 69 commits into from
Jun 28, 2024

Conversation

shravanngoswamii
Copy link
Member

@shravanngoswamii shravanngoswamii commented Jun 8, 2024

Now we have to make some changes in Turing.jl's workflow for triggering this workflow on new releases! Its not necessary because this will automatically update it when new commit will be made in this repo after version changes!

Copy link
Contributor

github-actions bot commented Jun 8, 2024

Preview the changes: https://turinglang.org/docs/pr-previews/478, Please avoid using the search feature and navigation bar in PR previews!

@shravanngoswamii shravanngoswamii requested a review from yebai June 8, 2024 04:15
@shravanngoswamii
Copy link
Member Author

Update: Changelog and Versions will be added to sidebar of docs and tutorials
TuringLang/turinglang.github.io#74 — this will be closed with it!

@shravanngoswamii
Copy link
Member Author

For the listing, only minor versions will be there now! In our gh-pages, should we have only minor versions or all? If all, then this PR is good to go!

@shravanngoswamii
Copy link
Member Author

Should we have Changelog inside versions dropdown?
Currently, it's like this:
Screenshot 2024-06-14 092957

@yebai
Copy link
Member

yebai commented Jun 14, 2024

Thanks @shravanngoswamii. Let's create a qmd file for versions, too, and link to it from the left menu, instead of maintaining a list in the quarto config file.

For the listing, only minor versions will be there now! In our gh-pages, should we have only minor versions or all? If all, then this PR is good to go!

We only list minor versions, but they should point to the most recent bugfix release, e.g. v0.33 should always point to v0.33.most_recent_release.

@shravanngoswamii
Copy link
Member Author

Ok, got it! I will update it soon!

@shravanngoswamii
Copy link
Member Author

link to it from the left menu, instead of maintaining a list in the quarto config file.

Updated the script!

We only list minor versions, but they should point to the most recent bugfix release, e.g. v0.33 should always point to v0.33.most_recent_release.

In latest version: latest bug fix version will appear
In Stable version: latest minor version will appear
In Previous Versions: all versions excluding latest, stable and those which have docs in our old site!
In Archived Versions: all our versions that are in our old website.

I need some suggestions:

  1. Latest version also have link to Changelog, so should we keep Change log link in left sidebar or not?
  2. Should we have a version's dropdown in nav bar or not (I think it's not necessary requirement!)

Have a look at versions file now: https://turinglang.org/docs/pr-previews/478/versions.html

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented Jun 15, 2024

I was adding the deprecation note in our old docs but I am having some issues understanding that site!
Each html file in our old docs have links to css file like these /v0.31/some/folder, even if site is of version v0.28.2 then also html files in that version have link like v0.28/some/file and these folders(v0.28, v0.31) do not even exist so how is the site getting styles?

update: I searched a bit and found out that its using symbolic links!

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented Jun 15, 2024

please also review the deprecation note in this: https://turing.shravangoswami.com/ui/v0.31.1/

@yebai
Copy link
Member

yebai commented Jun 17, 2024

Thanks @shravanngoswamii -- it looks nice.

Latest version also have link to Changelog, so should we keep Change log link in left sidebar or not?

Let's remove the link to change the log elsewhere except the one in versions.qmd.

Should we have a version's dropdown in nav bar or not (I think it's not necessary requirement!)

That would be nice if possible.

@shravanngoswamii shravanngoswamii linked an issue Jun 21, 2024 that may be closed by this pull request
@shravanngoswamii
Copy link
Member Author

I tried almost everything that I could, and I was not able to figure out what was the issue! Then suddenly I saw the issues of this workflow and found out that it does not support diffs that change single line, we can use it after this PR is merged!

@shravanngoswamii
Copy link
Member Author

@yebai This PR is good to go, that suggest changes workflow PR is merged — parkerbxyz/suggest-changes#31, and it's working fine now! You can see the example here: shravanngoswamii#46

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented Jun 28, 2024

Still I have one more question, when we update any previous release then docs will be pushed to that particular version along with the root folder. So should I put the if condition for pushing to root folder for latest version, I mean after these docs will only be pushed to root folder when VERSION is latest! But even if we do this, then what about the case where we need the changes of previous release in latest!

@yebai
Copy link
Member

yebai commented Jun 28, 2024

Still I have one more question, when we update any previous release then docs will be pushed to that particular version along with the root folder. So should I put the if condition for pushing to root folder for latest version, I mean after these docs will only be pushed to root folder when VERSION is latest!

Let's do it.

But even if we do this, then what about the case where we need the changes of previous release in latest!

One should always refer to explicitly versioned docs for previous releases.

@shravanngoswamii
Copy link
Member Author

Let's do it.

Done!

@yebai yebai merged commit 7a8fc92 into TuringLang:master Jun 28, 2024
4 checks passed
github-actions bot added a commit that referenced this pull request Jun 28, 2024
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.

Add a page for changelog
3 participants