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

Initial cleanup of documentation #488

Merged
merged 6 commits into from
Oct 12, 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
38 changes: 38 additions & 0 deletions .github/workflows/pdf-at-pr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# This workflow will install Python dependencies and generate PDF file at PR
name: Create offline documentation on PR

on:
pull_request:
types: [opened, reopened, synchronize, labeled]
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ 3.8 ]

steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel
pip install -r requirements.txt
- name: Run mkdocs --clean
run: |
mkdocs build --clean

- name: Upload pdf
uses: actions/upload-artifact@v4
with:
name: artifact
path: site/pdf/document.pdf

3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ pip install --use-pep517 -r requirements.txt
To build and serve the documentation locally, allowing you to make edits and observe the results in real time, use:

```bash
mkdocs build --clean && mkdocs serve
mkdocs build --clean
mkdocs serve -a 0.0.0.0:8000
```

You will be able to make edits to existing files and observe the results in real time.
Expand Down
40 changes: 0 additions & 40 deletions docs/Community_Governance.md

This file was deleted.

11 changes: 11 additions & 0 deletions docs/Community_IRC.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
---
title: Armbian Social Media Channels
description: Social media channels maintained by Armbian project team
---

# Social media

## Armbian on Twitter and Mastodon

Armbian short announcements are done via 𝕏 (formerly known as Twitter): <https://twitter.com/armbian> and <https://fosstodon.org/@armbian>

# IRC Channel / Discord / Matrix

## 👏 Overview
Expand Down
4 changes: 2 additions & 2 deletions docs/Developer-Guide_Build-Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Usage:

# Build options

These parameters are meant to be applied to the `./compile.sh` command. They are **all** optional. They can also be added to your [build configuration file](/Developer-Guide_Build-Preparation/#providing-build-configuration) to save time. Default values are marked **bold** if applicable.
These parameters are meant to be applied to the `./compile.sh` command. They are **all** optional. They can also be added to your [build configuration file](Developer-Guide_Build-Preparation.md#providing-build-configuration) to save time. Default values are marked **bold** if applicable.

## Main options

Expand Down Expand Up @@ -269,6 +269,6 @@ When selecting the zstd compression level (`zstd:[1-15]`), both the host and the
- **AUFS** ( **yes** | no ): include support for [AUFS](https://en.wikipedia.org/wiki/Aufs)
- **SKIP_BOOTSPLASH** ( yes | **no** ): use kernel bootsplash. Disable in case of troubles
- **CONSOLE_AUTOLOGIN** ( **yes** | no ): automatically login as root for local consoles. Disable if your security threat model requires.
- **EXT** (`fake-vcgencmd`): execute [extension](/Developer-Guide_Extensions/) during the build
- **EXT** (`fake-vcgencmd`): execute [extension](Developer-Guide_Extensions.md) during the build
- `fake-vcgencmd`: include [fake vcgencmd](https://github.com/clach04/fake_vcgencmd) to monitor and control boards from [Android](https://eidottermihi.github.io/rpicheck/)
- **INCLUDE_HOME_DIR** ( yes | **no** ): include directories created inside /home in final image.
60 changes: 0 additions & 60 deletions docs/Hardware_Allwinner-A20.md

This file was deleted.

45 changes: 0 additions & 45 deletions docs/Hardware_Allwinner-H3.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/Hardware_Allwinner-H5-A64.md

This file was deleted.

24 changes: 0 additions & 24 deletions docs/Hardware_Allwinner-H6.md

This file was deleted.

Loading