vanilla-os / documentation Goto Github PK

Add log command details to apx' manpage.md

on https://docs.vanillaos.org/handbook/en/installation#types-of-installation:

• Installing only Vanilla OS
• Advanced installation (Disabled currently)

both link to an empty page

Hello. Since your documentation is using Jekyll Ruby Framework, It may be difficult to make changes to the content, provide new translations, customize website’s look and so on, so i made a remake of your Documentation, written on Docusaurus. Below, you would see some pros and cons that will help you to make the decision. Thank you in advance.

Pros:

• Create user translations using Crowdin. (Also, easier to provide in-repo translations, because of project folder structure, which you can see here.)
• Ability to create new styles for the website, customize color theme (using simple json).
• Ability to download new plugins using yarn install @docusaurus/plugin_name, including Search-plugin, automatic Markdown generation, etc.
• New technologies. Docusaurus is a framework that works on JavaScript, allowing you to use any edge hosting (Vercel, Netlify, Deno Deploy) and consume minimum amount of RAM on VPS/VDS.

Cons:

• Slower builds of pages on GitHub Actions:
  • Building of entire website (including all the i18n translations) consume ~1.9 minutes.

You can check the deployed version here, and the repository with the source code here.

Vanilla-OS/vanilla-system-operator#28 --on-boot has been removed because it was unimplemented, but it still appears in the docs.

Quick fix available in #70

Obviously Orchid is still in beta, so it makes sense that the docs might not have made it to the site yet, but is there really no documentation for Orchid yet? An orchid branch for the repo with work in progress documentation would be handy to have, because a lot of the tools are nigh on impossible to use right now unless you've been involved in the development to some degree.

1. @Malix-off in the discord server :

   I have seen in
   https://vanillaos.org/blog/article/2024-07-22/interview-with-luca-di-maio-and-mirko-brombin-exploring-immutability-in-vanilla-os-2-orchid#how-does-the-atomicity-approach-in-vanilla-os-compare-to-other-operating-systems
   that it's fs independant, but are there some in which it works better (e.g. due to compression or thin-provisioning better interaction) ?

2. Tau in the discord server :

   ABRoot is filesystem independant.
   Vanilla itself only supports the LVM btrfs structure that the installer formats.
   ABRoot does work better with Copy-on-Write Filesystems tho like btrfs.

   For the var partition it doesn't really matter. I would still recommend btrfs but you can use pretty much anything.

In the “Multiple sources” section of docs/apx/index.md there is a link to https://documentation.vanillaos.org/docs/vanilla-control-center, which does not exist.

1. Introduction to Vanilla OS
2. Structure of Vanilla OS (Images, tools)
3. Docs about specific tools (manpage)
4. Full Changelogs for major versions

Excerpts from the recent meeting regarding new docs.

Edit. This is a tracking issue like Vanilla-OS/handbook#104, feel free to add your suggestions related to the new core documentation here.

When used in China, it is not possible to install the software faster through the default software source, so how to use the image acceleration service provided by a service provider like mirrors.aliyun.com ?

I recently came across Vanilla OS through a friend who described it as an "immutable Debian distro." Having had experience with an A-B system I made for another Debian project in the past, I was wondering if this could be an effort to implement something similar.

I started with the official web site, but it wasn't immediately evident what sets Vanilla OS apart from other Debian/Ubuntu distro until the part mentioning ABroot and OCI.

I read a bit about ABRoot in the documentation, but it is very vague about how it works technically. From my point of view, it reads like something that a snapshotting filesystem supplemented with an initramfs and bootloader hook could do, but nothing that would require a whole distro to achieve.

I came accross an other tool called VSO which seemed like a kind of timer/cron? Then APX which seems to be an important part of the project in how it handles multiple packages from different sources, a part that the main page doesn't clearly mention. I couldn't quickly understand how it'd be different from an extra packaging solution such as flatpak/snaps, for example.

I felt like it was important to share my experience as a new potential user that is taking a quick look before they decide to try a new OS.

The documentation is a bit unordered with introduction to subsystem appearing after the man pages and technical details. But the main issue remains that there's no definitive «About» page highlighting the unique selling points more prominently. Most of the main page explains what you can do with most other OS.

Hello, since this repo uses Jekyll for its documentation system, it may be hard to implement translations, plugins, change styles. I made a remake of this repo, which contains all the information (including translations), written on Docusaurus. Thank you.

https://github.com/Vanilla-OS/documentation/blob/main/docs/packaging/index.md
"Some applications require a lot of storage, and this can be a problem for Vanilla OS, which has a small root partition"

Using the GitHub Actions workflow is required to push your source code to GitHub Pages. You can copy the working file from here.

I recommend using yarn instead of npm(node.js default package manager), because YARN is supported in all the platform, that support Node.JS, but it provides faster packages delivery, ability to use .lock file instead of packages.json, that allows to download the exact version specified and the exact version of dependencies required by other packages. This makes yarn faster in CI/CD, than npm is.

Users with a BIOS only machine might be frustrated after downloading VOS, flashing it to a USB stick and then be confronted with the notice that UEFI is required.

I'm using Vanilla OS on VMWare, and I'm really enjoying it. Thanks for the great distro :) I love the idea of using containers for apps, and I hope that the distro keeps growing and improving.
I suggest a new section for the documentation that describes the differences between the different package managers. I'm curious about what would happen if I installed Firefox using the Arch rather than the Ubuntu repository. Would it be faster? I will get updated more often if I adopt Ubuntu repository as the default for my apps? Anyway, I'm just curious, I want to understand the advantages and cons of using nix over .dnf or even .deb over .rpm etc so I can choose the best package to fit my needs. I blv that the apx implementation is a feature of Vanilla OS, so it is worth explaining the user how to choose. Thanks for your time; keep pushing!

https://handbook.vanillaos.org/2023/01/11/install-and-manage-applications.html

https://github.com/Vanilla-OS/documentation/blob/main/docs/vso/manpage.md

Extra backtick under description, version:

version Show version and exit`

Currently docs states that a minimum 50 GB is required but it is asking for A partition and B partition, so how much one should keep them at minimum also how much other partitions should be sized should be documented imo.

Upon loading the VanillaOS docs on my phone, I noticed the main text was cut and unreadable on each and every page. Not only that, the navigation bar is taking the whole width of the page, but that isn't really the issue.
I, and a friend of mine, have both loaded the docs on our phones, on both Brave and Firefox for Android. I have also seen this behaviour on desktop (Brave for Windows) but only upon resizing the window to a very low aspect ratio.