From c93dc1f23cd6aa31fad77e58c33d795a26ecaca6 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Tue, 26 Mar 2024 12:03:25 +0530 Subject: [PATCH] cleanup: update notice Signed-off-by: K.B.Dharun Krishna --- _posts/2022-11-05-installation.md | 2 +- _posts/2022-11-11-contributing.md | 151 ------------------ _posts/2022-11-18-first-setup.md | 2 +- _posts/2022-12-09-install-flatpaks.md | 2 +- .../2022-12-10-install-additional-drivers.md | 2 +- _posts/2022-12-10-updates.md | 2 +- _posts/2023-01-02-install-distrobox.md | 2 +- _posts/2023-01-07-install-steam.md | 2 +- ...3-01-11-install-and-manage-applications.md | 2 +- _posts/2023-01-11-install-vpn-from-file.md | 2 +- _posts/2023-01-19-change-default-shell.md | 2 +- _posts/2023-01-21-install-in-vm.md | 2 +- .../2023-01-23-install-jekyll-and-bundler.md | 2 +- _posts/2023-01-24-install-openrgb.md | 2 +- _posts/2023-01-26-install-homebrew.md | 2 +- ...023-01-28-install-heroic-games-launcher.md | 2 +- _posts/2023-01-28-install-lutris.md | 2 +- _posts/2023-02-05-install-docker.md | 2 +- _posts/2023-10-26-install-vivaldi.md | 2 +- 19 files changed, 18 insertions(+), 169 deletions(-) delete mode 100644 _posts/2022-11-11-contributing.md diff --git a/_posts/2022-11-05-installation.md b/_posts/2022-11-05-installation.md index 988c69b..ee27281 100644 --- a/_posts/2022-11-05-installation.md +++ b/_posts/2022-11-05-installation.md @@ -9,7 +9,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Preparation diff --git a/_posts/2022-11-11-contributing.md b/_posts/2022-11-11-contributing.md deleted file mode 100644 index 2712d15..0000000 --- a/_posts/2022-11-11-contributing.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: Contribute to Handbook -description: Learn how to contribute to Vanilla OS Handbook. -date: 2022-11-11 -layout: article -authors: - - kbdharun - - kra-mo - - MonsterObserver -published: true ---- - -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. - -Thank you for your interest in our project. This guide will help you with writing articles. - -The [**Handbook**](https://github.com/Vanilla-OS/handbook) uses Jekyll and GitHub pages for generating the website. - -Handbook progress with a to-do list is present at our [**GitHub project**](https://github.com/orgs/Vanilla-OS/projects/2). - -## Prerequisites for Writing a guide - -A basic knowledge of [**Markdown**](https://www.markdownguide.org/basic-syntax/) is required for writing posts. - -## Writing a guide - -If you want to write a guide for the handbook, follow these instructions:- - -- Add the new article to the [**`_posts` directory**](https://github.com/Vanilla-OS/handbook/tree/main/_posts). -- The filename must be in the format `YYYY-MM-DD-title.md`. -- See [**markdownlint**](https://github.com/DavidAnson/markdownlint) for best markdown practices. -- The guide must use the following structure at the beginning: - -```md ---- -title: -description: -date: YYYY-MM-DD -layout: article -authors: - - 1st author GitHub username - - 2nd author GitHub username - - ... -published: true ---- -``` - -- You must fill in your article's metadata here. - -For example:- - -```md ---- -title: Installing a package -description: Learn how to install a package in Vanilla OS -date: 2023-01-13 -layout: article -authors: - - MonsterObserver -published: true ---- -``` - -- Add your GitHub username with the co-author's username(s) in the author's field to have working links when the post is published. -- Ensure images are in **WebP format** and placed in a dedicated directory under the `/assets/uploads` directory with a descriptive name for future reference. - -**_Tip_**: We suggest using [**cwebp**](https://developers.google.com/speed/webp/docs/cwebp) for converting the images to WebP. - -## Style Guide - -Headings should follow a proper hierarchy. - -Links must be in bold, commands in bold and backticks. - -For example:- - -```md -[**example**](https://example.com/) -[**`apx`**](https://github.com/Vanilla-OS/apx) -``` - -Which will have the following outputs:- [**example**](https://example.com/), [**`apx`**](https://github.com/Vanilla-OS/apx) - -Buttons in applications can be highlighted using double quotes (""). For example, the Install button gets highlighted as the "Install" button. - -Menus, command names and directories must be enclosed with backticks (`). - -For displaying commands, we suggest code blocks with the correct shell or programming language. - -For example:- - -```md -- To update your Vanilla OS system now, run the following command:- - -"```bash -sudo vso trigger-update --now -```" -(Note: " isn't required, and is used for quoting the syntax here) -``` - -The code block will have the following output:- - -```bash -sudo vso trigger-update --now -``` - -Some terms like "Note:" and "Tip:" should be highlighted with bold and italics. For example:- `**_Note_**:-`. - -## Testing the guide locally using Jekyll, Bundler - -You can install **Jekyll** from [**this page**](https://jekyllrb.com/docs/installation/) and **Bundler** can be installed from [**this page**](https://bundler.io). Or you can follow these steps in [**Vanilla OS**](/2023/01/23/install-jekyll-and-bundler.html). - -Clone your forked repository using `git` or `gh`. - -Add the guide to the correct destination in the cloned directory. - -Run `jekyll build` to build the page to `./_site` once. Then you can either test the pages manually or use the `jekyll serve` command. - -Run `jekyll serve` to build your site any time a source file changes and serve it locally. - -Navigate to `http://127.0.0.1:4000/` or `http://localhost:4000/` in your browser to preview and test the page. - -Now, commit the changes using `git` and create a PR in GitHub. - -**_Tip_**:- - -You can test your pages on your phone using `jekyll serve --host=`. - -Using `0.0.0.0` instead of a specific IP binds port 4000 to any interface, which is prone to be blocked by your routers firewalls. That's why we recommended using a particular IP address with the `--host` flag. After executing the command in any browser on your phone, go to this address `:4000`. - -For example, if the IP you used is `192.168.0.123`, you will need to visit `192.168.0.123:4000` on your mobile. - -## Embedding GitHub Gists - -GitHub gists are allowed for referencing custom mods and scripts in posts. - -For example, embedding this `` will have the following output:- - - - -## Archiving guides - -Removing guides and images from the repository isn't advised. - -For outdated articles and posts, we suggest changing the publishing status to `false` in the header, which removes it from the Glossary's listing and RSS feed. - -For outdated images, it is recommended to move them to the [**handbook-archive**](https://github.com/Vanilla-OS/handbook-archive) repository to prevent space. - -## Discussions - -For discussions regarding the handbook, go to the [**`#docs-writing`**](https://discord.com/channels/1023243680829681704/1035287786330263703) channel in the [**official Discord server**](https://discord.gg/3cD2Q7Ht3S). For Discussions regarding translations go to the [**`#translations`**](https://discord.com/channels/1023243680829681704/1037028192583692358) channel. Alternatively, you can collaborate with the docs team on our [**Matrix room**](https://matrix.to/#/#vanillaos-docs:matrix.org). diff --git a/_posts/2022-11-18-first-setup.md b/_posts/2022-11-18-first-setup.md index 6cde67a..01af308 100644 --- a/_posts/2022-11-18-first-setup.md +++ b/_posts/2022-11-18-first-setup.md @@ -9,7 +9,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2022-12-09-install-flatpaks.md b/_posts/2022-12-09-install-flatpaks.md index 4cff070..fbf8f4a 100644 --- a/_posts/2022-12-09-install-flatpaks.md +++ b/_posts/2022-12-09-install-flatpaks.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. Flatpak is a universal package format for Linux desktop applications. It works on most Linux distributions, Vanilla OS included. Flatpak applications get distributed as bundles, similar to native packages, but they are sandboxed and can be updated independently from the host system. diff --git a/_posts/2022-12-10-install-additional-drivers.md b/_posts/2022-12-10-install-additional-drivers.md index 5ddaa04..4851eab 100644 --- a/_posts/2022-12-10-install-additional-drivers.md +++ b/_posts/2022-12-10-install-additional-drivers.md @@ -10,7 +10,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. Drivers are software components that allow the operating system to communicate with hardware devices. diff --git a/_posts/2022-12-10-updates.md b/_posts/2022-12-10-updates.md index f4df048..42effae 100644 --- a/_posts/2022-12-10-updates.md +++ b/_posts/2022-12-10-updates.md @@ -9,7 +9,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. Vanilla OS is a point release distribution that receives two new releases annually with security updates and bug fixes for system components distributed between releases, usually without any new features introduced. diff --git a/_posts/2023-01-02-install-distrobox.md b/_posts/2023-01-02-install-distrobox.md index 63a4fde..f4cde38 100644 --- a/_posts/2023-01-02-install-distrobox.md +++ b/_posts/2023-01-02-install-distrobox.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## What is Distrobox? diff --git a/_posts/2023-01-07-install-steam.md b/_posts/2023-01-07-install-steam.md index ee74c91..918d654 100644 --- a/_posts/2023-01-07-install-steam.md +++ b/_posts/2023-01-07-install-steam.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## What is Steam? diff --git a/_posts/2023-01-11-install-and-manage-applications.md b/_posts/2023-01-11-install-and-manage-applications.md index f6dc2f7..8aa346c 100644 --- a/_posts/2023-01-11-install-and-manage-applications.md +++ b/_posts/2023-01-11-install-and-manage-applications.md @@ -9,7 +9,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2023-01-11-install-vpn-from-file.md b/_posts/2023-01-11-install-vpn-from-file.md index ecd460d..74670ef 100644 --- a/_posts/2023-01-11-install-vpn-from-file.md +++ b/_posts/2023-01-11-install-vpn-from-file.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2023-01-19-change-default-shell.md b/_posts/2023-01-19-change-default-shell.md index ab2cb96..b76399e 100644 --- a/_posts/2023-01-19-change-default-shell.md +++ b/_posts/2023-01-19-change-default-shell.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2023-01-21-install-in-vm.md b/_posts/2023-01-21-install-in-vm.md index cd35b18..16ef5b6 100644 --- a/_posts/2023-01-21-install-in-vm.md +++ b/_posts/2023-01-21-install-in-vm.md @@ -10,7 +10,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2023-01-23-install-jekyll-and-bundler.md b/_posts/2023-01-23-install-jekyll-and-bundler.md index 8cdf5dc..8b2ff00 100644 --- a/_posts/2023-01-23-install-jekyll-and-bundler.md +++ b/_posts/2023-01-23-install-jekyll-and-bundler.md @@ -9,7 +9,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2023-01-24-install-openrgb.md b/_posts/2023-01-24-install-openrgb.md index 54b703f..6ecd11f 100644 --- a/_posts/2023-01-24-install-openrgb.md +++ b/_posts/2023-01-24-install-openrgb.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2023-01-26-install-homebrew.md b/_posts/2023-01-26-install-homebrew.md index 41f23b7..65009a0 100644 --- a/_posts/2023-01-26-install-homebrew.md +++ b/_posts/2023-01-26-install-homebrew.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Terminologies diff --git a/_posts/2023-01-28-install-heroic-games-launcher.md b/_posts/2023-01-28-install-heroic-games-launcher.md index 9a48882..bef23da 100644 --- a/_posts/2023-01-28-install-heroic-games-launcher.md +++ b/_posts/2023-01-28-install-heroic-games-launcher.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## What is Heroic Games Launcher? diff --git a/_posts/2023-01-28-install-lutris.md b/_posts/2023-01-28-install-lutris.md index cff4a65..88c1874 100644 --- a/_posts/2023-01-28-install-lutris.md +++ b/_posts/2023-01-28-install-lutris.md @@ -8,7 +8,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## What is Lutris? diff --git a/_posts/2023-02-05-install-docker.md b/_posts/2023-02-05-install-docker.md index ec69728..5a1034e 100644 --- a/_posts/2023-02-05-install-docker.md +++ b/_posts/2023-02-05-install-docker.md @@ -10,7 +10,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction diff --git a/_posts/2023-10-26-install-vivaldi.md b/_posts/2023-10-26-install-vivaldi.md index 3880233..41a3676 100644 --- a/_posts/2023-10-26-install-vivaldi.md +++ b/_posts/2023-10-26-install-vivaldi.md @@ -9,7 +9,7 @@ authors: published: true --- -> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. +**_Note_**: This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. ## Introduction