From c1aa65c651cf3462c1e52f25d546a866fb05f1ef Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 29 Jan 2024 23:00:05 +0530 Subject: [PATCH] feat: add warnings for guides (#99) Signed-off-by: K.B.Dharun Krishna --- .gitattributes | 5 +++++ articles/en/change-default-shell.md | 2 ++ articles/en/contributing.md | 2 ++ articles/en/first-setup.md | 2 ++ articles/en/install-additional-drivers.md | 2 ++ articles/en/install-and-manage-applications.md | 2 ++ articles/en/install-distrobox.md | 2 ++ articles/en/install-docker.md | 2 ++ articles/en/install-flatpaks.md | 2 ++ articles/en/install-heroic-games-launcher.md | 2 ++ articles/en/install-homebrew.md | 2 ++ articles/en/install-in-vm.md | 2 ++ articles/en/install-jekyll-and-bundler.md | 2 ++ articles/en/install-lutris.md | 2 ++ articles/en/install-openrgb.md | 2 ++ articles/en/install-steam.md | 2 ++ articles/en/install-vpn-from-file.md | 2 ++ articles/en/installation.md | 2 ++ articles/en/updates.md | 2 ++ 19 files changed, 41 insertions(+) diff --git a/.gitattributes b/.gitattributes index 069ded3..1f0c821 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,7 @@ # Ref: https://git-scm.com/docs/gitattributes * text=auto eol=lf + +# GitHub linguist ignores markdown files by default, but artices +# are in markdown, so we explicitly make the pages detectable +articles/**/*.md linguist-detectable=true +articles/**/*.md linguist-documentation=false diff --git a/articles/en/change-default-shell.md b/articles/en/change-default-shell.md index 9869dd7..9ef36f4 100644 --- a/articles/en/change-default-shell.md +++ b/articles/en/change-default-shell.md @@ -6,6 +6,8 @@ Authors: - MonsterObserver --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction Vanilla OS allows you to change your Default Shell to optimize your workflow. This guide will show you how to change your Default Shell to [**Zsh**](https://zsh.sourceforge.io/) or [**Fish**](https://fishshell.com/). diff --git a/articles/en/contributing.md b/articles/en/contributing.md index 295539d..75097fa 100644 --- a/articles/en/contributing.md +++ b/articles/en/contributing.md @@ -8,6 +8,8 @@ Authors: - MonsterObserver --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + 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. diff --git a/articles/en/first-setup.md b/articles/en/first-setup.md index 09fc97c..1728555 100644 --- a/articles/en/first-setup.md +++ b/articles/en/first-setup.md @@ -7,6 +7,8 @@ Authors: - kbdharun --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction Congratulations, you have successfully installed Vanilla OS. diff --git a/articles/en/install-additional-drivers.md b/articles/en/install-additional-drivers.md index aec9885..4500e28 100644 --- a/articles/en/install-additional-drivers.md +++ b/articles/en/install-additional-drivers.md @@ -8,6 +8,8 @@ Authors: - mrunix00 --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + Drivers are software components that allow the operating system to communicate with hardware devices. In Vanilla OS, primary drivers are installed automatically during the first setup, but some devices may need additional drivers to work ideally. You can install them using two methods:- diff --git a/articles/en/install-and-manage-applications.md b/articles/en/install-and-manage-applications.md index e842eae..4676f67 100644 --- a/articles/en/install-and-manage-applications.md +++ b/articles/en/install-and-manage-applications.md @@ -7,6 +7,8 @@ Authors: - MonsterObserver --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction Vanilla OS allows installing packages and software from various sources. This guide will discuss them in detail. diff --git a/articles/en/install-distrobox.md b/articles/en/install-distrobox.md index 73719e0..21f5632 100644 --- a/articles/en/install-distrobox.md +++ b/articles/en/install-distrobox.md @@ -6,6 +6,8 @@ Authors: - mirkobrombin --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## What is Distrobox? [**Distrobox**](https://github.com/89luca89/distrobox) is a utility that allows you to run multiple Linux distributions in your system without the need to dual boot or install them in a virtual machine. It enables backward and forward compatibility with software and provides freedom to use whatever distribution you need. diff --git a/articles/en/install-docker.md b/articles/en/install-docker.md index 9065164..f0c1b92 100644 --- a/articles/en/install-docker.md +++ b/articles/en/install-docker.md @@ -7,6 +7,8 @@ Authors: - zedtux --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction [**Docker**](https://www.docker.com/) is an open platform for developing, shipping, and running applications in containerized environments. This guide provides the steps to install the Docker engine and Docker desktop in Vanilla OS. diff --git a/articles/en/install-flatpaks.md b/articles/en/install-flatpaks.md index bc6090c..1e3a3c2 100644 --- a/articles/en/install-flatpaks.md +++ b/articles/en/install-flatpaks.md @@ -6,6 +6,8 @@ Authors: - mirkobrombin --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + 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. ## Install Flatpak diff --git a/articles/en/install-heroic-games-launcher.md b/articles/en/install-heroic-games-launcher.md index df7967f..8b22e1f 100644 --- a/articles/en/install-heroic-games-launcher.md +++ b/articles/en/install-heroic-games-launcher.md @@ -6,6 +6,8 @@ Authors: - mirkobrombin --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## What is Heroic Games Launcher? [**Heroic Games Launcher**](https://heroicgameslauncher.com/) is an open source game launcher for Linux. It allows you to download and play games from the Epic Games Store and the GOG Galaxy client through a user-friendly interface. diff --git a/articles/en/install-homebrew.md b/articles/en/install-homebrew.md index a4433a4..96c4476 100644 --- a/articles/en/install-homebrew.md +++ b/articles/en/install-homebrew.md @@ -6,6 +6,8 @@ Authors: - kbdharun --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Terminologies - **Package Manager**:- A package manager or package-management system is a utility with a collection of software tools that automates installing, upgrading, configuring, and removing applications or packages. diff --git a/articles/en/install-in-vm.md b/articles/en/install-in-vm.md index 47bfd51..9a9eb24 100644 --- a/articles/en/install-in-vm.md +++ b/articles/en/install-in-vm.md @@ -8,6 +8,8 @@ Authors: - johnaaron-git --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction If you are interested in Vanilla OS, it's a good idea to try it out in a VM before using it on your hardware to get used to the Vanilla OS components. This guide will guide you through installing Vanilla OS with various VM software. diff --git a/articles/en/install-jekyll-and-bundler.md b/articles/en/install-jekyll-and-bundler.md index fdf0019..83621e3 100644 --- a/articles/en/install-jekyll-and-bundler.md +++ b/articles/en/install-jekyll-and-bundler.md @@ -7,6 +7,8 @@ Authors: - kbdharun --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction Jekyll is a popular static site generator for creating blogs, documentation, and personal websites. diff --git a/articles/en/install-lutris.md b/articles/en/install-lutris.md index c29c134..c61df2e 100644 --- a/articles/en/install-lutris.md +++ b/articles/en/install-lutris.md @@ -6,6 +6,8 @@ Authors: - mirkobrombin --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## What is Lutris? [**Lutris**](https://lutris.net/) is an open-source game launcher for Linux that allows you to download and play games from various platforms such as the Epic Games Store, GOG Galaxy client, Origin, Humble Bundle and many others through a simple interface. diff --git a/articles/en/install-openrgb.md b/articles/en/install-openrgb.md index 31c604f..3edb9dd 100644 --- a/articles/en/install-openrgb.md +++ b/articles/en/install-openrgb.md @@ -6,6 +6,8 @@ Authors: - MonsterObserver --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction [**OpenRGB**](https://openrgb.org/) is an essential application for managing your RGB appliances. This guide will help you install the Flatpak and AppImage of OpenRGB correctly. diff --git a/articles/en/install-steam.md b/articles/en/install-steam.md index d0850fd..dde6042 100644 --- a/articles/en/install-steam.md +++ b/articles/en/install-steam.md @@ -6,6 +6,8 @@ Authors: - mirkobrombin --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## What is Steam? [**Steam**](https://steampowered.com) is the most popular gaming platform. It allows you to download and play a vast library of games. It's client is available natively on Linux. diff --git a/articles/en/install-vpn-from-file.md b/articles/en/install-vpn-from-file.md index b969b09..245ce57 100644 --- a/articles/en/install-vpn-from-file.md +++ b/articles/en/install-vpn-from-file.md @@ -6,6 +6,8 @@ Authors: - gonzoknows --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Introduction This guide provides a step-by-step process for installing an OpenVPN file graphically without using the terminal. It helps users who may be uncomfortable with command-line interfaces or who prefer a more user-friendly approach. diff --git a/articles/en/installation.md b/articles/en/installation.md index 4394f62..ce3f760 100644 --- a/articles/en/installation.md +++ b/articles/en/installation.md @@ -7,6 +7,8 @@ Authors: - kbdharun --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + ## Preparation ### Requirements diff --git a/articles/en/updates.md b/articles/en/updates.md index f182ba8..12132b2 100644 --- a/articles/en/updates.md +++ b/articles/en/updates.md @@ -7,6 +7,8 @@ Authors: - kbdharun --- +> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. + 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. ## Difference between Update and Upgrade