Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add frontmatter to articles and format them #416

Merged
merged 1 commit into from
Oct 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 47 additions & 27 deletions docs/articles/en/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Getting Started with Apx
---
Title: Getting Started
Description: How to start using Apx on your system.
PublicationDate: 2024-10-18
Listed: true
Authors: -jardon
Tags:
- getting-started
---

Apx is designed to be a versatile, distro-agnostic tool that can be installed on any Linux distribution. Follow the steps below to get Apx up and running on your system.

Expand All @@ -13,36 +21,45 @@ Before installing Apx, ensure you have the following software installed:

## Installation Procedure

### Clone the Apx Repository
Open your terminal and run the following commands to clone the repository and navigate into it:
```bash
git clone --recursive https://github.com/Vanilla-OS/apx.git
cd apx
```

### Build Apx
Compile Apx by executing:
```bash
make build
```

### Install Apx
To install Apx system-wide, run:
```bash
sudo make install
```

### Install Apx Manpages
For the manual pages, execute:
```bash
sudo make install-manpages
```
### Clone the Apx Repository

Open your terminal and run the following commands to clone the repository and navigate into it:

```bash
git clone --recursive https://github.com/Vanilla-OS/apx.git
cd apx
```

### Build Apx

Compile Apx by executing:

```bash
make build
```

### Install Apx

To install Apx system-wide, run:

```bash
sudo make install
```

### Install Apx Manpages

For the manual pages, execute:

```bash
sudo make install-manpages
```

## Custom Installation Destination

You can change the installation prefix or destination using `PREFIX` and `DESTDIR`. Here are examples for custom installations:

- **Install Apx to `~/.local`**:

```bash
make install PREFIX=$HOME/.local
make install-manpages PREFIX=$HOME/.local
Expand Down Expand Up @@ -78,8 +95,10 @@ sudo apt install build-essential meson libadwaita-1-dev gettext desktop-file-uti

## Installation Procedure

### Clone the Apx-GUI Repository
### Clone the Apx-GUI Repository

Open your terminal and run the following commands to clone the repository and navigate into it:

```bash
git clone https://github.com/Vanilla-OS/apx-gui.git
cd apx-gui
Expand All @@ -93,6 +112,7 @@ Once you have cloned the repository, build Apx-GUI by running:
meson setup build
ninja -C build
```

> **NOTE:** you can set a custom installation destination by passing `--prefix=/path/to/dir` to `meson`

### Install Apx-GUI
Expand All @@ -111,4 +131,4 @@ You can launch Apx-GUI using the following command:
apx-gui
```

Follow these steps to successfully install and run Apx-GUI on your system. Enjoy managing your Apx installations with the graphical interface!
Follow these steps to successfully install and run Apx-GUI on your system. Enjoy managing your Apx installations with the graphical interface!
14 changes: 11 additions & 3 deletions docs/articles/en/introduction.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
# Introduction to APX
---
Title: Introduction
Description: Learn about Apx, a versatile command-line interface (CLI) tool designed to simplify the management of operating system containers.
PublicationDate: 2024-10-18
Listed: true
Authors:
- jardon
Tags:
- introduction
---

APX is a versatile command-line interface (CLI) tool designed to simplify the management of operating system containers. With a focus on efficiency and user-friendliness, APX empowers users to create, manage, and customize containers for a variety of applications and services.

Key features of APX include:

- **Subsystems**: APX supports the management of container-based operating systems running on top of the host. These are called subsystems in APX. They are lightweight and provide flexible environments that have no effect on the host system.
- **Subsystems**: APX supports the management of container-based operating systems running on top of the host. These are called subsystems in APX. They are lightweight and provide flexible environments that have no effect on the host system.

- **Stacks**: Organize related configurations and dependencies into cohesive groups called stacks. This feature creates consistent, reproducable environments to develop software, deploy workloads, or install packages that may be incompatible with your host system.

Expand All @@ -17,4 +26,3 @@ Key features of APX include:
By integrating these powerful features, APX provides developers and system administrators with the tools they need to efficiently manage their containerized applications and associated dependencies. Whether you're deploying microservices or managing development environments, APX helps you streamline your container management process.

Explore APX and discover a more efficient approach to managing your operating system containers, stacks, subsystems, and package managers!

17 changes: 15 additions & 2 deletions docs/articles/en/understanding-pmss.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
## Package Managers
---
Title: Understanding Package Managers and Stacks
Description: Learn about the key functions of package managers and stacks in APX, and how they streamline software management within operating system containers.
PublicationDate: 2024-10-18
Listed: true
Authors:
- jardon
Tags:
- package-managers
- understanding
---

In APX, package managers are essential components that facilitate the management of software packages within operating system containers. They provide a way to install, update, remove, and manage software dependencies seamlessly. Here’s an overview of what package managers do in APX:

### Key Functions of Package Managers in APX
Expand All @@ -12,6 +23,7 @@ In APX, package managers are essential components that facilitate the management
By integrating package managers into APX, users gain powerful tools to efficiently manage software installations and maintain their container environments, ultimately enhancing productivity and reducing complexity in application deployment and management.

## Stacks

In APX, stacks serve as the foundational templates from which subsystems are created. Each stack defines a combination of a container base and a curated list of packages to preinstall using a package manager, establishing a consistent environment for deployment. By using stacks, developers can ensure that all necessary components and configurations are in place before instantiating subsystems, simplifying the setup process and promoting uniformity across different applications. This structured approach facilitates efficient management of dependencies and enhances the overall reliability of the containerized environment.

### Key Features of Stacks in APX
Expand All @@ -27,6 +39,7 @@ In APX, stacks serve as the foundational templates from which subsystems are cre
By utilizing stacks in APX, users can enhance their ability to manage complex applications, maintain organized workflows, and ensure that all components work harmoniously within their containerized environments. This structured approach leads to more efficient development, testing, and deployment processes.

## Subsystems

In APX, subsystems function as containerized sandboxes that isolate and manage specific functionalities or services within an application environment. Each subsystem operates independently, ensuring that dependencies and configurations do not interfere with one another. This encapsulation enhances security, stability, and scalability, allowing developers to build and deploy applications with confidence, knowing that each subsystem can be maintained and updated without affecting the overall system.

### Key Features of Subsystems in APX
Expand All @@ -37,4 +50,4 @@ In APX, subsystems function as containerized sandboxes that isolate and manage s

3. **Interoperability**: Subsystems in APX enable interoperability in software by providing isolated, containerized environments that facilitate seamless communication and integration between diverse applications and components.

By leveraging subsystems in APX, users can build complex applications in a structured and efficient manner, enhancing their ability to manage individual components while maintaining a cohesive overall architecture. This approach supports rapid development cycles, easy integration of new features, and streamlined maintenance processes.
By leveraging subsystems in APX, users can build complex applications in a structured and efficient manner, enhancing their ability to manage individual components while maintaining a cohesive overall architecture. This approach supports rapid development cycles, easy integration of new features, and streamlined maintenance processes.
Loading