-
-
Notifications
You must be signed in to change notification settings - Fork 9
Prepare 2.0 release #80
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
Conversation
# Conflicts: # _data/mixManifest.json # package-lock.json
# Conflicts: # _data/mixManifest.json
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work @gchtr ! I found a few small things one reviewing the docs. Some are not directly connected to this PR though but are small improvements.
- https://timber.github.io/docs/v2/guides/posts/#extending-timber\post breaks anchor
- .toc a might be better as a inline-block, so the link does not stretch over the full width of the page
- pages link http://localhost:8080/docs/guides/custom-page-templates/ (v1) are not under the v1 slug. I think this might be more consistent.
|
@Levdbas Thanks a lot for your review! Fixed in e3e7f7b.
Fixed in 3ccbb96
Yes, I thought about that, too. But then we would have to create redirects for all v1 pages from |
|
Great work!
Hmm, on the other hand. It seems that the v1 docs have more "weight" currently then the soon to be new major version. What if we put all v1 docs under the /v1/ slug and then redirect all traffic to the new /v2/ as a permanent redirect. Some links will then give a 404 since we changed slugs etc. From there it might be easier to release a v3 in the future as well. I say, let's take the hit now if any and profit in the future. let me know what you think! |
|
Okay, you have a point here as well. It sure is cleaner for future versions and I didn’t consider the possible SEO hit yet. I guess for that to work, we would need to work through the following todos:
|
|
Gotcha! I will prepare a PR for the 2nd todo. That PR should be based on the 2.x branch right but for the /v1 docs. |
|
Thanks for taking over the second task!
Yes! |
|
Submitted at timber/timber#2836 |
|
@Levdbas Huh, I think I figured it all out. There’s a way in Eleventy to create pages from arrays, so the redirects should now be handled without us having to define them manually. I even managed to make it work so that if we release v3, all non-versioned links automatically point to v3. I’ll have a look at your PR soon. |
|
I added a fix for the archive pages in 11b2d7b. Maybe you can test it when you pull the latest Except for the section titles in the nav bar when accessing an archive page, everything seems to work fine. |
Levdbas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested a fix for the missing section titles, other that that we are good to go from what I can see!

This pull request prepares the docs for the 2.x release. It will be used in combination with timber/timber#2829.
https://timber.github.io/docs/tohttps://timber.github.io/docs/v2/.https://timber.github.io/docs/v1/.Testing
This version of the docs can be tested when
2.x-prepare-releasebranch is checked out in a timber directory right next to the docs directory.Then, from the docs folder, run
npm run build. You then usenpm run serveto check out the docs from the local web server address displayed in your terminal.