Repository navigation
Website for 1.2.8: dependency upgrades and documentation drift #554
Replies: 9 comments
|
Hi @MaEscalanteHe, Thank you so much for this. Honestly, it's a huge help. Keeping ProxMenux moving on my own means the documentation is often the first thing to fall behind, and I know there are times when it doesn't match the code. Seeing someone take the time to compare the docs against the current code, find around 45 outdated statements, and turn it all into a clear roadmap is a real gift to the project. The plan looks excellent, and working in small PRs, one per item so each is easy to review and revert, is exactly the right approach. Please go ahead and open the first PR to develop with block 1. On your questions: If you'd like to take care of the documentation on an ongoing basis, I'd be really happy to have you on board. It would be a magnificent contribution. Feel free to ping me with any questions about how a feature is supposed to behave. Thanks again, truly appreciated! |
|
Thanks @MacRimi, really glad it helps! I've opened the PR for block 1: #557. It also includes the Change Language entry in the sidebar, with its label translated into all eight languages. On scope, I'll go with blocks 1, 3 and 5 for 1.2.8 and leave the major upgrades and the missing pages for the next beta (1.2.8.1-beta, if I've got the numbering right). Your reply still had both options in brackets, so let me know if you meant the full scope instead. And yes, I'd be happy to keep looking after the docs. I'll ping you when I'm not sure how something is supposed to behave. |
|
Sorry about the brackets, I left both options in by mistake! Blocks 1, 3 and 5 for 1.2.8, and the major upgrades and missing pages for the next beta, is exactly what I meant. And yes, the numbering is right: 1.2.8.1-beta. I've left a comment on #557. It's only a small detail on two pages, and everything else is ready. Having you look after the docs is a real relief. Whenever you're unsure how something is meant to behave, just ask me here. |
|
Block 3 is done! Thanks @MacRimi for the reviews and the extra fixes, and thanks @Vaso73, @f3rs3n and @Umnov91 for going over the Slovak, Italian and Russian. These are the merged PRs:
OCI manager didn't need a PR, since the audit found nothing wrong there. Post-install and Help & Info weren't on the original list, but they had drift too, so I included them. Now that Russian is in, I'll include it in my PRs and tag Umnov91 on those changes (more on that in #599). The only thing left for 1.2.8 is block 5. I'll open one PR for the Once that's in, I'll start on blocks 2 and 4 for 1.2.8.1-beta. |
|
Great work on block 3, thank you! The docs match the code again, and adding Post-install and Help & Info was a good call. A note on timing: 1.2.8 is already out, so block 5 will ship with 1.2.8.1-beta, together with blocks 2 and 4. About guides/*.md, I'd delete them. The website already has the same four guides (NVIDIA, Samba in an LXC, cloud backup and Kodi), translated, with its own copies of the images in web/public/guides. Nothing in the repository links to those files, and the README already points to proxmenux.com/guides. Please remove the .md files and their image folders together. While you're on block 5: two glossary entries link to routes that don't exist. /guides/nvidia should be /guides/nvidia-manual, and /guides/backup_cloud should be /guides/backup-cloud. They could go in the same PR. |
|
Block 5 is up in #652: the The strict translation check is still open: I left a question for you in the PR, since fixing it means touching the docs translation script. Once that's settled, I'll start on blocks 2 and 4. |
|
Thanks a lot for block 5, it's merged now! The glossary links, the tags that showed up as text and the cleanup of I think the strict translation check ended up in a good place too: the exceptions for headers, captions, breadcrumbs and the Slovak FAQ label, with Whenever you're ready, please go ahead with blocks 2 and 4 for 1.2.8.1-beta. As always, if you're unsure how something is meant to behave, just ask me here. |
|
Thanks @MacRimi! Something you might have missed, since it went in at the end: while testing every page in all nine languages with I'm starting on blocks 2 and 4 now, beginning with Next 16 and Node 26. |
|
Block 2 is ready, @MacRimi. It ended up as six PRs instead of one per upgrade, because every upgrade touches
The six branches are already pushed and tested, so the previews show exactly what each PR will contain. One request: please keep merging them with a merge commit, as you did with the previous ones. With a squash the next branch would show these commits again and I would have to rebase it. Three things changed from the plan in the first post:
What you will notice on the site:
Things I found and left alone, in case you want them fixed:
I could not test the real deploy, since Next is block 4, the missing pages. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Hi! For 1.2.8 I'd like to take on the website. I compared the docs against the current code, and between outdated dependencies and documentation drift there's a fair amount to do, so I'm opening this thread to keep it in one place.
Mini-roadmap
1. Already done
On
feature/web-refreshin my fork, branched fromdevelop.zod,date-fns,react-markdown,gray-matter,fs,pathand a few more), pinned the"latest"ranges and applied the minor and patch updates.npm auditdrops from 15 vulnerabilities to 6, none of them critical.<and>literally, for exampledisk-<device>. The fix is a single change ini18n/loadMessages.ts, which turns the entities into ICU quoting, so the catalogs and the translation checker stay as they are.storage-share/host-local-diskshowed a raw message key instead of the text, in all eight languages.Merged in #557.
2. Major upgrades (moved to 1.2.8.1-beta)
Each upgrade gets its own PR, with a full build and a check in the browser.
postcssadvisory.@tailwindcss/typographyandtailwind-merge3.@types/react/@types/react-dom18 to 19 so they match React 19.katexandmermaidadvisories.lucide-react1.x,recharts3,react-resizable-panels4,sonner2 andhtml-react-parser6.setRequestLocale, deprecated since next-intl 4.14.tsc, but that path is still marked experimental. If it causes trouble, TypeScript 6 is the fallback.3. Documentation drift
About 45 statements across 30 pages no longer match the code. I'd fix them section by section, one PR each, English first. Some examples:
config_menu.shalready offers it./api/auth/ssl/*is/api/ssl/*, and the exclusions live under/api/health/*), and tokens and SSL are placed under Settings instead of Admin → Security.lxc-samba-serverdocuments GID 999 while the code uses 101000, andpersistent-namessuggestsrm 10-*.link, which would also delete files the user created.format-disk,add-controller-nvme-vm,import-disk-lxc) describe behaviour the scripts no longer have.Sections: Settings & Introduction, Monitor, Backup & Restore, OCI manager, Storage & Share, Disk Manager, Hardware, Create VM, Network, Security and Utils.
4. Missing pages (moved to 1.2.8.1-beta)
custom-imagepage also still says multi-service Compose files are blocked.5. Smaller items
Merged in #652.
<code>tags as plain text: changelog, AI assistant, access & auth and cross-kernel.guides/*.mdin the repo have drifted from the website guides; we should decide whether to keep them. Removed, the website has the same guides.How I'd work
developwith block 1, which is ready.Questions
All reactions