Skip to content

Commit

Permalink
feat: add warnings for guides (#99)
Browse files Browse the repository at this point in the history
Signed-off-by: K.B.Dharun Krishna <[email protected]>
  • Loading branch information
kbdharun authored Jan 29, 2024
1 parent fbf83bf commit c1aa65c
Show file tree
Hide file tree
Showing 19 changed files with 41 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions articles/en/change-default-shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
2 changes: 2 additions & 0 deletions articles/en/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/first-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-additional-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:-
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-and-manage-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-distrobox.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-flatpaks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-heroic-games-launcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-homebrew.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-in-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-jekyll-and-bundler.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-lutris.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-openrgb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-steam.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/install-vpn-from-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions articles/en/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions articles/en/updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c1aa65c

Please sign in to comment.