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

2.x Prepare 2.0 release #2829

Merged
merged 6 commits into from
Nov 9, 2023
Merged

2.x Prepare 2.0 release #2829

merged 6 commits into from
Nov 9, 2023

Conversation

gchtr
Copy link
Member

@gchtr gchtr commented Oct 26, 2023

Related:

Issue

Right before releasing 2.0, we should update the documentation.

Solution

Prepare the changes.

Impact

None.

Usage Changes

None.

Considerations

None.

Testing

No.

@gchtr gchtr requested a review from Levdbas October 26, 2023 10:06
@gchtr gchtr mentioned this pull request Oct 26, 2023
30 tasks
Co-authored-by: Erik van der Bas <[email protected]>
@gchtr
Copy link
Member Author

gchtr commented Oct 26, 2023

Once v2 will go live, will the docs still live under the /v2/ slug? And do we need to prepare for that?

Yes, we still need to prepare for that. I mainly need to work on this in the https://github.com/timber/docs repository.

I thought about moving the /v2/ slug to the main docs path (https://timber-docs.test/docs/). But then, all existing links that specifically link to v2 documentation will not work anymore. We would have to create redirects for those (complicated). And also, all links to v1 docs wouldn’t lead to the intended page.

The solution I think would work better is to keep the version in the path. The Laravel Documentation already does something similar (e.g. with a link https://laravel.com/docs/10.x/installation).

To make this work well, the following steps are needed:

Levdbas
Levdbas previously approved these changes Oct 26, 2023
@Levdbas
Copy link
Member

Levdbas commented Oct 26, 2023

Once v2 will go live, will the docs still live under the /v2/ slug? And do we need to prepare for that?

Yes, we still need to prepare for that. I mainly need to work on this in the https://github.com/timber/docs repository.

I thought about moving the /v2/ slug to the main docs path (https://timber-docs.test/docs/). But then, all existing links that specifically link to v2 documentation will not work anymore. We would have to create redirects for those (complicated). And also, all links to v1 docs wouldn’t lead to the intended page.

The solution I think would work better is to keep the version in the path. The Laravel Documentation already does something similar (e.g. with a link https://laravel.com/docs/10.x/installation).

To make this work well, the following steps are needed:

* Make the homepage (https://timber-docs.test/docs/) show the v2 docs.

* Create https://timber-docs.test/docs/v1/ as an entry point for the v1 docs, but keep all v1 pages without /v1/ in the path.

* Show a banner in all v1 pages with an info that 2.x is the newer version. This could be similar to how Twig does this.
  ![CleanShot 2023-10-26 at 14 05 42](https://user-images.githubusercontent.com/2084481/278323869-bac48139-5df6-4e98-911e-e8aec56d5a31.png)

Let me know if you need some help with that @gchtr

@gchtr
Copy link
Member Author

gchtr commented Oct 26, 2023

Let me know if you need some help with that @gchtr

Thanks for offering your help. I will create a pull request in the docs repo that you can then test in a local environment.

@gchtr
Copy link
Member Author

gchtr commented Oct 29, 2023

@Levdbas I’ve created a pull request in timber/docs#80. I’d be happy if you could check that out!

@gchtr gchtr requested a review from Levdbas October 29, 2023 21:26
@gchtr
Copy link
Member Author

gchtr commented Nov 7, 2023

Another fix in d7163f1 to make the section archives work, see timber/docs#80 (comment).

@gchtr gchtr merged commit 2ac1a40 into 2.x Nov 9, 2023
@gchtr gchtr deleted the 2.x-prepare-release branch November 9, 2023 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants