Skip to content

Commit

Permalink
docs: Migrate docs to a separate repo (#1668)
Browse files Browse the repository at this point in the history
* ci(docs): Remove deploy docs action

See issue #1667

* ci(docs): Adapt offline docs step in build to pull from new docs repo

See issue #1667

* docs: Move docs to new repo

See issue #1667

* docs: Replace links from ublue-os.github.io/bazzite to docs.bazzite.gg

See issue #1667

* docs: Add readme with link pointing to new documentation repo
  • Loading branch information
Zeglius authored Sep 14, 2024
1 parent 827a704 commit c486c03
Show file tree
Hide file tree
Showing 190 changed files with 25 additions and 7,761 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ jobs:

# Prepare offline documentation
- run: mkdir -p ${{ github.workspace }}/system_files/desktop/shared/usr/share/ublue-os/docs/html
- name: Checkout docs repo
run: git clone https://github.com/KyleGospo/docs.bazzite.gg.git ${{ github.workspace }}/docs
- name: Build offline documentation
uses: ./.github/workflows/build_mkdocs
continue-on-error: true
Expand Down
98 changes: 0 additions & 98 deletions .github/workflows/deploy_docs.yml

This file was deleted.

16 changes: 8 additions & 8 deletions README-BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ O Bazzite é feito a partir do [ublue-os/main](https://github.com/ublue-os/main)
- Usa o [controle de congestionamento TCP BBR da Google](https://github.com/google/bbr) por padrão.
- [Input Remapper](https://github.com/sezanzeb/input-remapper) pré-instalado e habilitado. <sub><sup>(Disponível mas desabilitado por padrão na versão Deck, ative executando `ujust _restore-input-remapper`)</sup></sub>
- O Bazzite Portal traz um jeito simples de instalar múltiplos aplicativos e ajustes, incluindo a instalação do [LACT](https://github.com/ilya-zlobintsev/LACT).
- [Waydroid](https://waydro.id/) pré-instalado para rodar aplicativos Android. Confira esse [guia rápido](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Waydroid_Setup_Guide/) para configurá-lo.
- [Waydroid](https://waydro.id/) pré-instalado para rodar aplicativos Android. Confira esse [guia rápido](https://docs.bazzite.gg/Installing_and_Managing_Software/Waydroid_Setup_Guide/) para configurá-lo.
- Gerencie aplicativos usando o [Flatseal](https://github.com/tchx84/Flatseal), [Warehouse](https://github.com/flattool/warehouse), e [Gear Lever](https://github.com/mijorus/gearlever).
- Drivers i2c-piix4 e i2c-nct6775 pra [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB) para controlar o RGB em certas placas-mãe.
- Drivers [OpenRazer](https://openrazer.github.io) inclusos, Selecione OpenRazer no Bazzite Portal ou rode `ujust install-openrazer` no terminal para começar a usá-lo.
Expand All @@ -81,7 +81,7 @@ Imagem genérica disponível como `bazzite`, própria para computadores desktop.
- Atualiza automaticamente o sistema, Flatpaks, e todos os containers Distrobox - via [ublue-update](https://github.com/ublue-os/ublue-update) e [topgrade](https://github.com/topgrade-rs/topgrade).

> [!IMPORTANT]
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://docs.bazzite.gg/General/Installation_Guide/).**
Rebaseie de uma instalação existente de Fedora Atômico para esta imagem se você quiser **Drivers de GPU Open Source**:
(Nota: A solução Open Source Mesa para GPUs NVIDIA, NVK ainda é propensa a erros quando esta orientação é redigida, pra qualquer problema pertinente à NVK [por favor mande um relatório ao projeto Mesa]([url](https://docs.mesa3d.org/bugs.html)), não ao Ublue/Bazzite)
Expand Down Expand Up @@ -138,7 +138,7 @@ Imagem feita pra ser utilizada como alternativa ao SteamOS no Steam Deck, e para
> **Devido a um bug upstream, o Bazzite não pode ser utilizado em Steam Decks com 64GB de armazenamento eMMC no momento. Fazer um upgrade de armazenamento resolve o problema.**
> [!IMPORTANT]
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://docs.bazzite.gg/General/Installation_Guide/).**
Pra fazer rebase de uma instalação existente de Fedora Atômico para esta imagem:

Expand Down Expand Up @@ -170,7 +170,7 @@ Imagens com o ambiente desktop GNOME estão disponíveis pra ambas as versões d
- Atualizações automáticas para o [tema GNOME pro Firefox](https://github.com/rafaelmardojai/firefox-gnome-theme) e o [tema GNOME pro Thunderbird](https://github.com/rafaelmardojai/thunderbird-gnome-theme). <sup><sub>(Se instalados)</sub></sup>

> [!IMPORTANT]
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
> **ISOs podem ser baixadas do nosso [site](https://download.bazzite.gg), com um guia de instalação conveniente disponível [aqui](https://docs.bazzite.gg/General/Installation_Guide/).**
Pra fazer rebase de uma instalação existente de Fedora Atômico para esta imagem:

Expand Down Expand Up @@ -222,7 +222,7 @@ Apesar deste projeto também ser baseado em imagens, você pode instalar qualque

O Bazzite inclui a versão mais recente do kernel Linux e vem com SELinux habilitado por padrão com suporte total a secure boot <sub><sup>(Execute `ujust enroll-secure-boot-key` e insira a senha `universalblue` se requisitada para adicionar a nossa chave)</sup></sub> e criptografia de disco, fazendo dele uma solução razoável pra computação em geral. <sup><sub>(Sim, você pode usar sua impressora no Bazzite)</sub></sup>

Confira o [FAQ](https://ublue-os.github.io/bazzite/General/FAQ/) para mais detalhes no que faz o Bazzite ser diferente de outros sistemas operacionais Linux.
Confira o [FAQ](https://docs.bazzite.gg/General/FAQ/) para mais detalhes no que faz o Bazzite ser diferente de outros sistemas operacionais Linux.

## Imagens

Expand All @@ -236,9 +236,9 @@ Confira o [FAQ](https://ublue-os.github.io/bazzite/General/FAQ/) para mais detal

## Documentação

- [Instalando e Gerenciando Programas](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/)
- [Atualizações, Rollbacks, e Rebase](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
- [Guia pra Gaming](https://ublue-os.github.io/bazzite/Gaming/)
- [Instalando e Gerenciando Programas](https://docs.bazzite.gg/Installing_and_Managing_Software/)
- [Atualizações, Rollbacks, e Rebase](https://docs.bazzite.gg/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
- [Guia pra Gaming](https://docs.bazzite.gg/Gaming/)

Leia [documentação adicional](http://docs.bazzite.gg/) ao redor do projeto.

Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Bazzite is built from [ublue-os/main](https://github.com/ublue-os/main) and [ubl
- Uses [Google's BBR TCP congestion control](https://github.com/google/bbr) by default.
- [Input Remapper](https://github.com/sezanzeb/input-remapper) preinstalled and enabled. <sub><sup>(Available but default-disabled on the Deck variant, may be enabled with `ujust restore-input-remapper`)</sup></sub>
- Bazzite Portal provides an easy way to install numerous applications and tweaks, including installing [LACT](https://github.com/ilya-zlobintsev/LACT).
- [Waydroid](https://waydro.id/) preinstalled for running Android apps. Set it up with this [quick guide](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Waydroid_Setup_Guide/).
- [Waydroid](https://waydro.id/) preinstalled for running Android apps. Set it up with this [quick guide](https://docs.bazzite.gg/Installing_and_Managing_Software/Waydroid_Setup_Guide/).
- Manage applications using [Flatseal](https://github.com/tchx84/Flatseal), [Warehouse](https://github.com/flattool/warehouse), and [Gear Lever](https://github.com/mijorus/gearlever).
- [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB) i2c-piix4 and i2c-nct6775 drivers for controlling RGB on certain motherboards.
- [OpenRazer](https://openrazer.github.io) drivers built in, Select OpenRazer in Bazzite Portal or run `ujust install-openrazer` in a terminal to begin using it.
Expand All @@ -81,7 +81,7 @@ Common variant available as `bazzite`, suitable for desktop computers.
- Automatic updates for the OS, Flatpaks, and all Distrobox containers - powered by [ublue-update](https://github.com/ublue-os/ublue-update) and [topgrade](https://github.com/topgrade-rs/topgrade).

> [!IMPORTANT]
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://docs.bazzite.gg/General/Installation_Guide/).**
Rebase from an existing upstream Fedora Atomic to this image if you want **Open Source GPU Drivers**:
(Please note: Mesa's Open Source option for NVIDIA GPUs, NVK is still prone to errors at the time of writing, for any issues relating to NVK [please submit a report with Mesa]([url](https://docs.mesa3d.org/bugs.html)), not Ublue/Bazzite)
Expand Down Expand Up @@ -132,13 +132,13 @@ Variant designed for usage as an alternative to SteamOS on the Steam Deck, and f
- Built in support for display overclocking. For example, add `CUSTOM_REFRESH_RATES=30-68` to `/etc/environment`. Minimum and maximum refresh rates differ per handheld!
- 32GB RAM mod your Steam Deck? Enjoy double the maximum VRAM amount, automatically applied. <sup><sub>(Can you share your soldering skills?)</sub></sup>
- Steam Deck hardware-specific services can be disabled by running `ujust disable-bios-updates` and `ujust disable-firmware-updates` in the terminal. These are automatically disabled on non-Deck hardware, and on Decks with DeckHD displays or 32GB RAM mods.
- More information can be found [here](https://ublue-os.github.io/bazzite/Handheld_and_HTPC_edition/Steam_Gaming_Mode/) on the Bazzite Steam Deck images.
- More information can be found [here](https://docs.bazzite.gg/Handheld_and_HTPC_edition/Steam_Gaming_Mode/) on the Bazzite Steam Deck images.

> [!WARNING]
> **Due to an upstream bug, Bazzite cannot be used on Steam Decks with 64GB eMMC storage at this time. Upgrading the storage resolves the issue.**
> [!IMPORTANT]
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://docs.bazzite.gg/General/Installation_Guide/).**
Rebase from an existing upstream Fedora Atomic to this image:

Expand All @@ -148,7 +148,7 @@ rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/bazzite-deck:stabl

#### Alternative Handhelds

Please refer to our [Handheld Wiki](https://ublue-os.github.io/bazzite/Handheld_and_HTPC_edition/Handheld_Wiki/) for required setting changes and Decky Loader plugins for Steam Gaming Mode on your specific Handheld.
Please refer to our [Handheld Wiki](https://docs.bazzite.gg/Handheld_and_HTPC_edition/Handheld_Wiki/) for required setting changes and Decky Loader plugins for Steam Gaming Mode on your specific Handheld.

**Be sure to also read the [hhd documentation](https://github.com/hhd-dev/hhd#after-install), some handhelds require specific setting changes/tweaks to function properly.**

Expand All @@ -170,7 +170,7 @@ Builds with the GNOME desktop environment are available in both desktop and deck
- Automatic updates for the [Firefox GNOME theme](https://github.com/rafaelmardojai/firefox-gnome-theme) and [Thunderbird GNOME theme](https://github.com/rafaelmardojai/thunderbird-gnome-theme). <sup><sub>(If installed)</sub></sup>

> [!IMPORTANT]
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://ublue-os.github.io/bazzite/General/Installation_Guide/).**
> **ISOs can be downloaded from our [website](https://download.bazzite.gg), and a helpful install guide can be found [here](https://docs.bazzite.gg/General/Installation_Guide/).**
Rebase from an existing upstream Fedora Atomic to this image:

Expand Down Expand Up @@ -222,7 +222,7 @@ Despite this project also being image-based, you are able to install any Fedora

Bazzite ships with the latest Linux kernel and SELinux enabled by default with full support for secure boot <sub><sup>(Run `ujust enroll-secure-boot-key` and enter the password `universalblue` if prompted to enroll our key)</sup></sub> and disk encryption, making this a sensible solution for general computing. <sup><sub>(Yes, you can print from Bazzite)</sub></sup>

Read the [FAQ](https://ublue-os.github.io/bazzite/General/FAQ/) for details on what makes Bazzite stand out from other Linux based operating systems.
Read the [FAQ](https://docs.bazzite.gg/General/FAQ/) for details on what makes Bazzite stand out from other Linux based operating systems.

## Showcase

Expand All @@ -236,9 +236,9 @@ Read the [FAQ](https://ublue-os.github.io/bazzite/General/FAQ/) for details on w

## Documentation

- [Installing and Managing Applications](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/)
- [Updates, Rollbacks, and Rebasing](https://ublue-os.github.io/bazzite/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
- [Gaming Guide](https://ublue-os.github.io/bazzite/Gaming/)
- [Installing and Managing Applications](https://docs.bazzite.gg/Installing_and_Managing_Software/)
- [Updates, Rollbacks, and Rebasing](https://docs.bazzite.gg/Installing_and_Managing_Software/Updates_Rollbacks_and_Rebasing/)
- [Gaming Guide](https://docs.bazzite.gg/Gaming/)

View [additional documentation](http://docs.bazzite.gg/) surrounding the project.

Expand Down
Loading

0 comments on commit c486c03

Please sign in to comment.