diff --git a/content/community.en.md b/content/community.en.md index a973634776c0325f0e6e1cba3aaed694ff6a5e44..a662ff474d13531e2983de330e8228593af64f4d 100644 --- a/content/community.en.md +++ b/content/community.en.md @@ -14,25 +14,31 @@ Matrix is the official way to talk with Redox OS team/community (these rooms are Matrix has several different clients. [Element](https://element.io/) is a commonly used choice. +- Join this room and don't forget to request an invite to the Redox space. + (We recommend that you leave the "Join Requests" room after your entry on Redox space) ## [GitLab](https://gitlab.redox-os.org/redox-os/redox) A bit more formal way of communication with fellow Redox devs, but a little less quick and convenient like the chat. Submit an issue when you run into problems compiling, testing, or just would like to discuss a certain topic, be it features, code style, code inconsistencies, minor changes and fixes, etc. +## [Lemmy](https://lemmy.world/c/redox) + +Our alternative to Reddit, we post news and community threads. + ## [Reddit](https://www.reddit.com/r/Redox/) If you want a quick look at what's going on and talk about it. [reddit.com/r/rust](https://www.reddit.com/r/rust) for related Rust news and discussions. -## [Mastodon](https://fosstodon.org/@redox) +## [Fosstodon](https://fosstodon.org/@redox) -News and related content. +Our alternative to Twitter, we post news and community threads. -## [Mattermost](https://chat.redox-os.org) +## [Twitter](https://twitter.com/redox_os) -Until recently, we have been using a Mattermost chat server, which we are currently maintaining for historical purposes. Contact us on Redox OS/General if you need access to the Mattermost server. +News and community threads. ## [Forum](https://discourse.redox-os.org/) @@ -42,6 +48,6 @@ This is our historical forum with old/classic questions, it's inactive and must Redox talks given at various events and conferences. -### Note +## Note Community outreach is an important part of Redox's success. If more people know about Redox, then more contributors are likely to step in, and everyone can benefit from their added expertise. You can make a difference by writing articles, talking to fellow OS enthusiasts, or looking for communities that would be interested in knowing more about Redox. diff --git a/content/community.pt.md b/content/community.pt.md index 0f2036758436ef6e7d538f33f996b35355ee4cd0..8063ab3ad8643f92a56b7d203a8a9868b1b70d8f 100644 --- a/content/community.pt.md +++ b/content/community.pt.md @@ -14,6 +14,8 @@ Matrix é a forma de comunicação oficial com o time/comunidade do Redox OS (ac A rede Matrix tem diferentes clientes, [Element](https://element.io/) é o mais utilizado. +- Entre na sala e não esqueça de solicitar um convite para o espaço do Redox. + (Nós recomendamos que você saia da sala "Join Requests" depois de entrar no espaço do Redox) ## [GitLab](https://gitlab.redox-os.org/redox-os/redox) @@ -22,25 +24,26 @@ Uma forma mais formal de comunicação com os desenvolvedores do Redox, porém m Envie uma Issue se você tiver problemas compilando/testando ou apenas queira discutir algum assunto, seja funções, estilo de código, inconsistências de código, pequenas mudanças ou correções. +## [Lemmy](https://lemmy.world/c/redox) + +Nossa alternativa ao Reddit, postamos notÃcias e tópicos da comunidade. + ## [Reddit](https://www.reddit.com/r/Redox/) Caso queira ver as novidades e discutir sobre. [reddit.com/r/rust](https://www.reddit.com/r/rust) - Para notÃcias relacionadas a Rust e discussões. -## [Mastodon](https://fosstodon.org/@redox) - -NotÃcias e conteúdo relacionado. +## [Fosstodon](https://fosstodon.org/@redox) -## [Mattermost](https://chat.redox-os.org) +Nossa alternativa ao Twitter, postamos notÃcias e tópicos da comunidade. -Até recentemente, estavamos utilizando o servidor de chat Mattermost, o qual nós estamos hospedando para consulta histórica. +## [Twitter](https://twitter.com/redox_os) -Nos chame em "Redox OS/General" se você precisar acessar o servidor Mattermost. +NotÃcias e tópicos da comunidade. ## [Fórum](https://discourse.redox-os.org/) -This is our historical forum with old/classic questions, it's inactive and must be used for historical purposes, if you have a question, send on Matrix. Nosso fórum histórico com perguntas clássicas/antigas, está inátivo e deve ser usado para consulta histórica. Se você tem uma pergunta, faça no chat Matrix. diff --git a/content/docs.en.md b/content/docs.en.md index 7aa12afc830fb3fdcce8b4b7ba46062e7303a316..e581a09d4c5e3ac84f83c5f9f41c6017398ba2d0 100644 --- a/content/docs.en.md +++ b/content/docs.en.md @@ -14,6 +14,8 @@ We highly recommend that you start with the [Book](https://doc.redox-os.org/book - [libstd](https://doc.rust-lang.org/stable/std/) - Documentation for the Rust standard library. +- [Drivers](https://gitlab.redox-os.org/redox-os/drivers/-/blob/master/README.md) - High-level documentation of the drivers. + - [RFCs](https://gitlab.redox-os.org/redox-os/rfcs) - Request for Changes to Redox. - [Ion Manual](https://doc.redox-os.org/ion-manual/) - Documentation for the Ion shell. diff --git a/content/docs.pt.md b/content/docs.pt.md index c465765e130d546814cc32d3246d8fc594595b05..3a967fad51c50769c836f34b2f4f578de6d009af 100644 --- a/content/docs.pt.md +++ b/content/docs.pt.md @@ -14,6 +14,8 @@ Nós recomendamos que você comece pelo [Livro](https://doc.redox-os.org/book/), - [libstd](https://doc.rust-lang.org/stable/std/) - Documentação para a biblioteca padrão da Rust. +- [Drivers](https://gitlab.redox-os.org/redox-os/drivers/-/blob/master/README.md) - Documentação de alto nÃvel dos drivers. + - [RFCs](https://gitlab.redox-os.org/redox-os/rfcs) - Solicitação de Mudanças para o Redox. - [Manual da Ion](https://doc.redox-os.org/ion-manual/) - Documentação para a shell Ion. diff --git a/content/faq.en.md b/content/faq.en.md index a45a952e0401a3471e736ce96743bb369d8024d2..d1a1722bad17e9dec4f48ff2a39689a2f07b45bd 100644 --- a/content/faq.en.md +++ b/content/faq.en.md @@ -14,6 +14,7 @@ This page covers the most asked questions. - [What is a microkernel?](#what-is-a-microkernel) - [What programs can Redox run?](#what-programs-can-redox-run) - [How to install programs on Redox?](#how-to-install-programs-on-redox) +- [Which are the Redox variants?](#which-are-the-redox-variants) - [Which devices does Redox support?](#which-devices-does-redox-support) - [Which virtual machines does Redox have integration with?](#which-virtual-machines-does-redox-have-integration-with) - [How do I build Redox?](#how-do-i-build-redox) @@ -33,6 +34,8 @@ Wherever possible, the system components are written in Rust and run in user-spa Redox is a alpha/beta quality software, because we implement new features while fix the bugs. +Thus it's not ready for daily usage yet, feel free to test the system until its maturity and **don't store your sensitive data without a proper backup.** + The version 1.0 will be released once all system APIs are considered stable. ## What does Redox mean? @@ -55,17 +58,17 @@ Most system components run in user-space on a microkernel system, a bug in a non #### No-reboot design -The kernel changes very little (bug fixing), so you won't need to restart your system very often to update the system. +A mature microkernel changes very little (bug fixing), so you won't need to restart your system very often to update the system. -Since most of the system components are in user-space, they can be replaced on-the-fly (reducing downtime for server administrators). +Since most of the system components are in userspace, they can be replaced on-the-fly (reducing downtime for server administrators). #### Easy to develop and debug -Most of the system components run in user-space, simplifying testing/debugging. +Most of the system components run in userspace, simplifying testing/debugging. ### Rust benefits -#### No need for exploit mitigations +#### No need for C/C++ exploit mitigations The microkernel design written in Rust protects against C/C++ memory defects. @@ -73,13 +76,13 @@ By isolating the system components from the kernel, the [attack surface](https:/ #### Improved security and reliability without significant performance impact -As the kernel is small, it uses less memory to do its work and the limited kernel code helps keep it close to bug-free status ([KISS](https://en.wikipedia.org/wiki/KISS_principle) goal). +As the kernel is small, it uses less memory to do its work and the limited kernel code size helps to keep it close to bug-free status ([KISS](https://en.wikipedia.org/wiki/KISS_principle) goal). -Rust's safe and fast language design, combined with the small size of the kernel code base, helps ensure a reliable, performant and easy to maintain core. +Rust's safe and fast language design, combined with the small kernel code size, helps ensure a reliable, performant and easy to maintain core. #### Rust-written drivers -Drivers written in Rust are likely to have fewer bugs and better security. +Drivers written in Rust are likely to have fewer bugs and therefore are more secure. - [Currently supported devices](#which-devices-does-redox-support) @@ -168,6 +171,22 @@ Redox has a package manager similar to `apt` (Debian) and `pkg` (FreeBSD), you c - [Redox package manager](https://doc.redox-os.org/book/ch02-08-pkg.html) +## Which are the Redox variants? + +Redox has some variants for each task, take a look on them below: + +- `server-minimal` - The most minimal variant with a basic system, aimed for embedded devices, very old computers and developers. + +- `desktop-minimal` - The most minimal variant with the Orbital desktop environment included, aimed for embedded devices, very old computers and developers. + +- `server` - The server variant with a complete system and network tools, aimed for server administrators, embedded devices, low-end computers and developers. + +- `desktop` - The standard variant with a complete system, Orbital desktop environment and useful tools, aimed for daily usage, producers, developers and gamers. + +- `dev` - The development variant with a complete system and development tools, aimed for developers. + +- `demo` - The demo variant with a complete system, tools, players and games, aimed for testers, gamers and developers. + ## Which devices does Redox support? There are billions of devices with hundreds of models/architectures in the world, we try to write drivers for the most used devices to support more people, some drivers are device-specific and others are architecture-specific. diff --git a/content/faq.pt.md b/content/faq.pt.md index ba991f1178f493183a57023f1d930959104d8271..47c27b7af1e6c381fe7a1b3b0c8f6307ac927f84 100644 --- a/content/faq.pt.md +++ b/content/faq.pt.md @@ -14,6 +14,7 @@ Essa página cobre as perguntas mais comuns. - [O que é um microkernel?](#o-que-%C3%A9-um-microkernel) - [Quais programas o Redox executa?](#quais-programas-o-redox-executa) - [Como instalar programas no Redox?](#como-instalar-programas-no-redox) +- [Quais são as variantes do Redox?](#quais-são-as-variantes-do-redox) - [Quais dispositivos o Redox suporta?](#quais-dispositivos-o-redox-suporta) - [Quais máquinas virtuais o Redox possui integração?](#quais-m%C3%A1quinas-virtuais-o-redox-possui-integra%C3%A7%C3%A3o) - [Como compilar o Redox?](#como-compilar-o-redox) @@ -33,6 +34,8 @@ Onde for possÃvel, os componentes do sistema serão escritos em Rust e executam O Redox está em qualidade alpha/beta, pois implementamos novas funções enquanto corrigimos bugs. +Portanto, ele não está pronto para uso diário, sinta-se livre para testar o sistema até sua maturidade e **não armazene arquivos sensÃveis sem o devido backup.** + A versão 1.0 será lançada quando todas as APIs do sistema forem consideradas estáveis. ## O que Redox significa? @@ -59,9 +62,9 @@ O kernel é pequeno e muda muito pouco (correção de bugs), portanto você não ### BenefÃcios da Rust -#### Sem necessidade para mitigações de exploit +#### Sem necessidade para mitigações de exploit das linguagens C e C++ -O design em microkernel escrito em Rust protege contra as falhas de memória da C/C++, por isolar o sistema do kernel, a superfÃcie de ataque é muito limitada. +O design de um microkernel escrito em Rust protege contra as falhas de memória das linguagens C e C++, isolando o sistema do kernel a superfÃcie de ataque é muito limitada. #### Sistema de arquivos inspirado no ZFS @@ -77,7 +80,7 @@ O design seguro e veloz da linguagem Rust, combinado com a pequena quantidade de #### Drivers escritos em Rust -Drivers escritos em Rust possuem incentivos para ter menos bugs e melhor segurança. +Drivers escritos em Rust possuem incentivos para ter menos bugs e portanto melhor segurança. - [Dispositivos suportados atualmente](#quais-dispositivos-o-redox-suporta) @@ -85,7 +88,6 @@ Drivers escritos em Rust possuem incentivos para ter menos bugs e melhor seguran A maioria dos componentes do sistema estão no espaço do usuário, simplificando a depuração. - ## Qual o propósito do Redox? O objetivo principal do Redox é ser um sistema de propósito geral com foco em segurança, confiabilidade e correção. @@ -165,6 +167,22 @@ O Redox tem um gerenciador de pacotes similar ao `apt` (Debian) e `pkg` (FreeBSD - [Gerenciador de Pacotes do Redox](https://doc.redox-os.org/book/ch02-08-pkg.html) +## Quais são as variantes do Redox? + +O Redox possuà variantes para cada tarefa, leia sobre elas abaixo: + +- `server-minimal` - A variante mais enxuta com um sistema básico, destinada a dispositivos embarcados, computadores muito antigos e programadores. + +- `desktop-minimal` - A variante mais enxuta com o ambiente de desktop Orbital incluÃdo, destinado para dispositivos embarcados, computadores muito antigos e programadores. + +- `server` - A variante para servidores, com um sistema completo e ferramentas de rede, destinado para admnistradores de rede, dispositivos embarcados, computadores fracos e programadores. + +- `desktop` - A variante padrão com um sistema completo, o ambiente de desktop Orbital e ferramentas úteis, destinado para o uso diário, produtores, programadores e jogadores. + +- `dev` - A variante para desenvolvimento com um sistema completo e ferramentas de programação, destinado para programadores. + +- `demo` - A variante para demonstração com um sistema completo, ferramentas, reprodutores e jogos, destinado para testadores, jogadores e programadores. + ## Quais dispositivos o Redox suporta? Há bilhões de dispositivos com centenas de modelos/arquiteturas no mundo, nós tentamos escrever drivers para os dispositivos mais utilizados para ajudar mais pessoas, alguns drivers são especÃficos para um dispositivo e outros são especÃficos de arquitetura. diff --git a/content/news/community-announcements-1.md b/content/news/community-announcements-1.md new file mode 100644 index 0000000000000000000000000000000000000000..080d316c14d98e72dea21d7c3e10095ccb563076 --- /dev/null +++ b/content/news/community-announcements-1.md @@ -0,0 +1,54 @@ ++++ +title = "Community Announcements - Matrix, Fosstodon, Lemmy and YouTube" +author = "Ribbon" +date = "waiting" ++++ + +This post will cover the important changes for community on this year. + +## Matrix + +It was decided that Matrix will be our permanent way for communication. + +Since January the Redox project was testing Matrix as the new platform for community/development communication, Jeremy Soller migrated to Matrix because of its maturity and popularity. + +A Matrix [space](https://matrix.to/#/#redox:matrix.org) for Redox was created with some rooms, more were added over time, you can see the current state below: + +- [#redox-join:matrix.org](https://matrix.to/#/#redox-join:matrix.org) - a room to be invited to the Redox space. +- [#redox-general:matrix.org](https://matrix.to/#/#redox-general:matrix.org) - a room for Redox-related discussions (questions, suggestions, porting, etc). +- [#redox-dev:matrix.org](https://matrix.to/#/#redox-dev:matrix.org) - a room for development, here you can talk about anything development-related (code, proposals, achievements, styling, bugs, etc). +- [#redox-support:matrix.org](https://matrix.to/#/#redox-support:matrix.org) - a room for testing/building support (problems, errors, questions). +- [#redox-mrs:matrix.org](https://matrix.to/#/#redox-mrs:matrix.org) - a room to cover all ready merge requests without conflicts (if you have a ready MR to merge, send there). +- [#redox-board:matrix.org](https://matrix.to/#/#redox-board:matrix.org) - a room for Board of Directors meetings. +- [#redox-voip:matrix.org](https://matrix.to/#/#redox-voip:matrix.org) - a room for voice/video calls. +- [#redox-random:matrix.org](https://matrix.to/#/#redox-random:matrix.org) - a room for off-topic. + +Jeremy decided to use the [Rust Code Of Conduct](https://www.rust-lang.org/policies/code-of-conduct) as rules for the rooms. + +The Redox space is invite-only, every new member must join the "Join Requests" room and request an invite to the Redox space. + +Only members of the Redox space can see/join the rooms. + +(This system satisfy our needs properly) + +The power of all moderators is limited and a room for moderators is available, we discuss moderation-related issues there. + +If we have problems with the `matrix.org` instance, probably we can host one using the Synapse server (the same of `matrix.org`) because of its maturity. + +Conduit is a Matrix server is written in Rust but is not ready for production use yet. + +## Fosstodon + +Fosstodon is an alternative for Twitter, we have more control over our content there. + +- [Fosstodon](https://fosstodon.org/@redox) + +We plan to migrate the userbase of Twitter to Fosstodon. + +## Lemmy + +Lemmy is an FOSS alternative to Reddit, we have more control over our content there. + +- [Lemmy](https://lemmy.world/c/redox) + +We plan to migrate the userbase of Reddit to Lemmy. diff --git a/content/news/documentation-improvements.md b/content/news/documentation-improvements.md new file mode 100644 index 0000000000000000000000000000000000000000..2c56ceee81e151b5e9e6de31b497b4cca10566a6 --- /dev/null +++ b/content/news/documentation-improvements.md @@ -0,0 +1,97 @@ ++++ +title = "Documentation Improvements - FAQ, Book and GitLab" +author = "Ribbon" +date = "2023-07-13" ++++ + +In February I decided to contribute to Redox after following it since 2016, as an obvious movement I tried to build Redox on my Fedora and had an error with NetSurf recipe compilation (fixed when I installed the Vim package), as I didn't know how to customize the Redox build system, I used Podman and it was very slow for a unknown reason (very boring to my testing workflow). + +After some time I learned how to customize the build system, removed the NetSurf recipe and the build finished without an error. + +The book was not clear/complete and a FAQ was not available, then I decided to improve this as my first contribution to the Redox project. + +Thanks Ron Williams, Jeremy Soller and 4lDO2 for your help with my questions. + +## FAQ + +Every project should have a FAQ for newcomers, it ease their life a lot and brings more interest to the project as the questions are satisfied. + +Redox lacked one for years, probably because the developers were busy with the code, then I decide to create one. + +I wrote the FAQ in a way that even Unix/Linux newcomers can understand, it's similar to the BSD system FAQs and wikis. + +- [FAQ](https://www.redox-os.org/faq/) + +(I maintain the Portuguese translation too) + +## Book improvements + +(The book cover the high-level documentation and not the code APIs, read [this](https://doc.redox-os.org/book/ch11-02-writing-docs-correctly.html) page to understand) + +Some parts of the book were outdated for years because the developers were busy with the code, Ron Williams improved it since the end of 2022 and I continued where he left. + +95% of the book was improved and new pages were crated by me to improve the organization, hundreds of hours of work and thousands of lines changed (Me and Ron are deciding how to organize it properly, we both agree that the book must hold cold information while the website hold the hot information). + +Like the FAQ, I decided to document the Redox in the most easy way possible with workflows/methods that cover most use cases in the development. + +(I'm the current book maintainer) + +A non-exaustive list of my improvements: + +- Several fixes on formatting +- All global hyperlinks converted to local ones + + - Global hyperlink example + + ``` + [link] + + [link]: link here + ``` + + Global hyperlinks are sensible to typos and more time consuming to organize, thus more error-prone. + + - Local hyperlink example + + ``` + [link](link-here) + ``` + + More simple, less typos. + +- Several fixes on Markdown code formatting +- [The build system was completely documented](https://doc.redox-os.org/book/ch08-06-build-system-reference.html) +- [The package manager was documented](https://doc.redox-os.org/book/ch02-08-pkg.html) +- [The Cookbook recipe system was completely documented](https://doc.redox-os.org/book/ch09-03-porting-applications.html) +- [All Cookbook templates documented](https://doc.redox-os.org/book/ch09-03-porting-applications.html#templates) +- [Most Cookbook custom template scripts documented](https://doc.redox-os.org/book/ch09-03-porting-applications.html#custom-template) - more will come. +- More troubleshooting options +- Added a way to update the toolchain +- Software porting process was documented +- Manual configuration of Podman was documented +- [RedoxFS was documented](https://doc.redox-os.org/book/ch04-08-redoxfs.html) +- [The microkernels explanation was improved a lot](https://doc.redox-os.org/book/ch04-01-microkernels.html) +- [A high-level explanation of the kernel was created](https://doc.redox-os.org/book/ch04-02-kernel.html) +- [A high-level explanation of the userspace was created](https://doc.redox-os.org/book/ch04-06-user-space.html) +- [A high-level explanation of the Redox graphics/windowing system was created](https://doc.redox-os.org/book/ch04-09-graphics-windowing.html) +- [A high-level explanation of the Redox security](https://doc.redox-os.org/book/ch04-10-security.html) +- [More side projects were documented](https://doc.redox-os.org/book/ch01-07-side-projects.html) +- [All crates were documented](https://doc.redox-os.org/book/ch08-06-build-system-reference.html#crates) +- [More configuration options were documented](https://doc.redox-os.org/book/ch02-07-configuration-settings.html) +- [Coding and building workflow documentation was improved a lot](https://doc.redox-os.org/book/ch09-02-coding-and-building.html) +- [Bug reporting was improved a lot](https://doc.redox-os.org/book/ch12-03-creating-proper-bug-reports.html) +- [Merge request workflow was improved](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html) +- [A branch-based workflow was documented](https://doc.redox-os.org/book/ch12-06-branch-workflow.html) +- [The Chat page was improved](https://doc.redox-os.org/book/ch13-01-chat.html) + +## GitLab + +I improved some documentation of the GitLab repositories too, generally this information is moved from the book or duplicated for easy access. + +A non-exaustive list of my improvements: + +- [CONTRIBUTING was cleaned/improved a lot](https://gitlab.redox-os.org/redox-os/redox/-/blob/master/CONTRIBUTING.md) - it was very old. +- [redox README was cleaned/improved a lot](https://gitlab.redox-os.org/redox-os/redox/-/blob/master/README.md) +- [All drivers were documented](https://gitlab.redox-os.org/redox-os/drivers/-/blob/master/README.md) +- [`redoxer` README was improved](https://gitlab.redox-os.org/redox-os/redoxer/-/blob/master/README.md) +- [Added a command to kill all QEMU processes after a kernel panic](https://gitlab.redox-os.org/redox-os/kernel/-/blob/master/README.md#notes) \ No newline at end of file