From c8ab817771fa64cebbc1f1fb1f58f704a88f4934 Mon Sep 17 00:00:00 2001 From: ericbsd Date: Sat, 22 Mar 2025 21:46:12 -0300 Subject: [PATCH] Reworking getting-started --- _static/dark_mode.css | 9 +- conf.py | 2 +- contributor/contributor-levels.md | 2 +- contributor/documentation-pl.md | 2 +- contributor/documentation.md | 5 +- contributor/getting-started-pl.md | 190 --------------------------- contributor/getting-started.md | 183 -------------------------- contributor/getting-started/index.md | 121 +++++++++++++++++ contributor/index.md | 14 ++ index.md | 9 +- 10 files changed, 154 insertions(+), 383 deletions(-) delete mode 100644 contributor/getting-started-pl.md delete mode 100644 contributor/getting-started.md create mode 100644 contributor/getting-started/index.md diff --git a/_static/dark_mode.css b/_static/dark_mode.css index a68cb5d..7c35c08 100644 --- a/_static/dark_mode.css +++ b/_static/dark_mode.css @@ -187,4 +187,11 @@ body.dark-mode .wy-menu-vertical li.toctree-l3.current { /* Ensure the inside li.toctree-l3.current does not override the background */ body.dark-mode .wy-menu-vertical li.toctree-l3.current a { background-color: transparent !important; -} \ No newline at end of file +} + +/* Fix inline background in dark mode */ +body.dark-mode code.docutils.literal.notranslate { + background-color: #232323; /* Match your
 background */
+    border-radius: 3px;
+    border-color: #3c3c3c;
+}
diff --git a/conf.py b/conf.py
index 500f862..ffc2516 100644
--- a/conf.py
+++ b/conf.py
@@ -48,7 +48,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ['README.md']
 
 
 # -- Options for HTML output -------------------------------------------------
diff --git a/contributor/contributor-levels.md b/contributor/contributor-levels.md
index fecc537..bc4fa8e 100644
--- a/contributor/contributor-levels.md
+++ b/contributor/contributor-levels.md
@@ -1,7 +1,7 @@
 GhostBSD Contributor Levels
 ===========================
 
-## 1. Junior Contributors
+## 1. New Contributors
 **Description:** New members who are actively contributing to the project.
 
 **Access and Permissions:** Access to public repositories with full capabilities to create branches and submit pull requests.
diff --git a/contributor/documentation-pl.md b/contributor/documentation-pl.md
index 05121e7..4a99e2c 100644
--- a/contributor/documentation-pl.md
+++ b/contributor/documentation-pl.md
@@ -13,7 +13,7 @@ Te trzy platformy komunikacyjne są ze sobą połączone. Bez względu na to, cz
 
 ## Uzyskiwanie zasobów
 
-Aby dokumentować projekty GhostBSD, warto uruchomić [najnowszą wersję GhostBSD](https://www.ghostbsd.org/download#latest_builds), a do dokumentowania projektów innych firm potrzebna będzie również najnowsza wersja tego programu. Używamy [Sphinx](https://www.sphinx-doc.org) z [MyST](https://myst-parser.readthedocs.io), co ułatwia tworzenie naszego Centrum Dokumentacji. Każdy, kto chce pomóc, powinien zacząć zapoznawać się z [Git](getting-started.md#knowing-how-to-use-git), [GitHub](getting-started.md#knowing-how-to-use-github) i [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html).
+Aby dokumentować projekty GhostBSD, warto uruchomić [najnowszą wersję GhostBSD](https://www.ghostbsd.org/download#latest_builds), a do dokumentowania projektów innych firm potrzebna będzie również najnowsza wersja tego programu. Używamy [Sphinx](https://www.sphinx-doc.org) z [MyST](https://myst-parser.readthedocs.io), co ułatwia tworzenie naszego Centrum Dokumentacji. Każdy, kto chce pomóc, powinien zacząć zapoznawać się z [Git](getting-started/getting-started.md#knowing-how-to-use-git), [GitHub](getting-started/getting-started.md#knowing-how-to-use-github) i [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html).
 
 Instrukcje dotyczące instalacji i konfiguracji można znaleźć w repozytorium [GhostBSD Documentation GitHub](https://github.com/ghostbsd/documentation#local-development-server).
 
diff --git a/contributor/documentation.md b/contributor/documentation.md
index d539de2..f546d19 100644
--- a/contributor/documentation.md
+++ b/contributor/documentation.md
@@ -1,4 +1,5 @@
-

Documentation Contribution

+Documentation Contribution +========================== Writing documentation is a great way to start improving GhostBSD user experience and you will be helping a lot of GhostBSD users to better understand their desktop and applications. Anyone with reasonable English skills and good knowledge of FreeBSD, GhostBSD or MATE can help. @@ -13,7 +14,7 @@ Those three messaging platform are connected together. So whatever you use IRC, ## Getting the resources -In order to document GhostBSD projects, you will want to run a [recent GhostBSD build](https://www.ghostbsd.org/download#latest_builds), and to document third-party projects, you will also need a recent version of that program. We are use [Sphinx](https://www.sphinx-doc.org) with [MyST](https://myst-parser.readthedocs.io) to makes it easy to create our Documentation Hub. Any one that wants to help should start to be familiar with [Git](getting-started.md#knowing-how-to-use-git), [GitHub](getting-started.md#knowing-how-to-use-github) and [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html). +In order to document GhostBSD projects, you will want to run a [recent GhostBSD build](https://www.ghostbsd.org/download#latest_builds), and to document third-party projects, you will also need a recent version of that program. We are use [Sphinx](https://www.sphinx-doc.org) with [MyST](https://myst-parser.readthedocs.io) to makes it easy to create our Documentation Hub. Any one that wants to help should start to be familiar with [Git](getting-started/getting-started.md#knowing-how-to-use-git), [GitHub](getting-started/getting-started.md#knowing-how-to-use-github) and [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html). The instructions for install and setup can be found on the [GhostBSD Documentation GitHub](https://github.com/ghostbsd/documentation#local-development-server) repository. diff --git a/contributor/getting-started-pl.md b/contributor/getting-started-pl.md deleted file mode 100644 index aad1699..0000000 --- a/contributor/getting-started-pl.md +++ /dev/null @@ -1,190 +0,0 @@ -

Rozpoczęcie Pracy

- -## Wymagania - -### Znajomość Języka Angielskiego - -Deweloperzy pochodzą z całego świata; jeśli mówisz po angielsku, będziesz w stanie współpracować z każdym. - -Nie musisz być biegły w angielskim ani mieć doskonałej znajomości tego języka, ale musisz rozumieć angielski na tyle, aby móc się komunikować. - -[](#git) - -### Znajomość Git - -Git to system kontroli wersji, którego używamy do śledzenia zmian. Korzystamy z niego cały czas i wszędzie. - -```suggestion -Jeśli nie znasz Git, zatrzymaj się na chwilę i poznaj go. - -Aby nauczyć się Git, odwiedź [Dokumentację GitHub](https://docs.github.com/en/get-started/quickstart/set-up-git). - -Upewnij się, że znasz pojęcia takie jak commity, gałęzie, zdalne repozytoria, przywracanie zmian i rebase. - -### Znajomość GitHub - -Używamy GitHub do hostowania naszych repozytoriów Git i współpracy nad kodem. - -Będziesz musiał mieć założone konto na GitHubie. - -Aby założyć konto na GitHubie, odwiedź [GitHub](https://github.com/). - -Będziesz także musiał wiedzieć, jak używać GitHub do przeglądania zmian w kodzie, forka projektu, tworzenia pull requestów itp. - -Aby prawidłowo skonfigurować swoje konto na GitHubie i nauczyć się korzystać z GitHub, odwiedź [Pomoc GitHub](https://docs.github.com). - -### Uruchamianie GhostBSD - -Do większości projektów będziesz potrzebować komputera z zainstalowaną najnowszą wersją GhostBSD. - -Możesz uruchomić wcześniejszą wersję lub FreeBSD, ale jeśli uruchomisz najnowszą wersję GhostBSD, masz pewność, że wszystko będzie działać. - -## Konfiguracja - -Poniżej opisano, jak skonfigurować swój komputer. - -### Utwórz Piaskownicę Projektów - -Dobrze jest utworzyć katalog na wszystkie swoje potrzeby związane z pracą przy projekcie, w którym będziesz mieć podkatalogi dla każdego projektu lub grupy projektów. Dzięki temu wszystko będzie uporządkowane na Twoim komputerze, co ułatwi przeszukiwanie kodu w różnych projektach. - -Zazwyczaj nazywamy nasz główny katalog roboczy „Sandbox” i umieszczamy go w naszym katalogu domowym. - -``` -mkdir ~/projects/ghostbsd -``` - -Oczywiście możesz nazwać go według własnego uznania i umieścić gdziekolwiek chcesz. - -## Technologie - -Poniżej znajduje się przegląd technologii, których używamy. - -### Języki Programowania - -W GhostBSD używamy różnych języków programowania. - -Nie musisz znać ich wszystkich ani znać ich dobrze. W rzeczywistości zależy to od projektu, nad którym chcesz pracować, i tego, co chcesz osiągnąć. - -Oto języki, które używamy najczęściej. - -#### Python - -Większość aplikacji programowych i narzędzi konfiguracyjnych jest napisanych w Pythonie. - -Zaletą Pythona jest to, że jest łatwy do nauki i szybki w rozwoju. - -#### C - -Wiele aplikacji i większość bibliotek jest napisanych w C. - -Język C jest języku typu low-level, trudny do opanowania i żmudny w rozwoju, ale zapewnia szybkie działanie i jest najbardziej wspieranym językiem w FreeBSD — prawie wszystko jest dostępne z poziomu C. - -#### Skrypt powłoki Bourne - -Większość skryptów w FreeBSD używa skryptów [Bourne shell (sh)](https://en.wikipedia.org/wiki/Bourne_shell). Niektóre narzędzia GhostBSD, takie jak ghostbsd-build i xconfig, są napisane w Bourne shell. - -### Biblioteki i Narzędzia GNOME - -Wszystkie nasze interfejsy użytkownika używają zestawu narzędzi [GTK3](https://docs.gtk.org/gtk3/). - -Nasze prace rozwojowe w dużym stopniu opierają się na bibliotekach GNOME, w szczególności intensywnie korzystamy z GLib i GObject. - -Głównie używamy Pythona i uzyskujemy dostęp do tych bibliotek za pomocą [GObject Introspection](https://gi.readthedocs.io). - -### Narzędzia - -#### Środowisko Rozwoju - -Do pisania i edytowania kodu możesz używać dowolnych narzędzi. Niektórzy preferują lekkie edytory, inni pełnoprawne IDE. To kwestia gustu. Rozwój to przede wszystkim zabawa, więc najważniejsze jest, abyś lubił narzędzia, z których korzystasz. - -Jeśli nie jesteś pewien, co wybrać, poszukaj i wypróbuj kilka edytorów/IDE, aż znajdziesz ten, który najbardziej Ci odpowiada. - -Eric używa [Sublime Text](https://www.sublimetext.com/). - -``` -sudo pkg install linux-sublime3 -``` -lub -``` -sudo pkg install linux-sublime-text4 -``` - -Jeśli zainstalujesz Sublime, zainstaluj również [Package Control](https://packagecontrol.io/installation) i użyj go do zainstalowania rozszerzeń *GitGutter* i *TrailingSpaces*. - -[Visual Studio Code](https://code.visualstudio.com/) jest również bardzo popularnym wyborem. - -``` -sudo pkg install vscode -``` - -Istnieje wiele edytorów kodu dostępnych w GhostBSD, możesz wybrać swój ulubiony edytor. - -#### Kontrola Wersji - -W zakresie kontroli wersji używamy tylko Gita i niczego innego. Cały nasz kod jest kontrolowany wersjami za pomocą Gita. - -Nie musisz jednak korzystać wyłącznie z linii poleceń Gita. - -Oto kilka narzędzi, które mogą ułatwić korzystanie z Gita. - -`gitk`, choć jest nieestetyczny i wygląda na przestarzały (został opracowany w Tcl/Tk), jest bardzo przydatny do szybkiego przeglądania historii commitów, tworzenia gałęzi i wybierania commitów. - -Możesz zainstalować go z repozytoriów: -``` -pkg install git-gui -cd ~/projects/ghostbsd -git clone https://github.com/ghostbsd/ghostbsd-ports.git -cd ghostbsd-ports -gitk -``` -W katalogu projektu wystarczy wpisać `gitk`, aby zobaczyć historię commitów. Możesz także określić nazwę gałęzi, aby zobaczyć tę gałąź, lub podkatalog, aby zobaczyć historię konkretnego katalogu. - -`gitg` choć jest bardzo podobny i wygląda lepiej (używa Gtk), jego zestaw funkcji jest nieco inny. -``` -pkg install gitg -cd ~/projects/ghostbsd -git clone https://github.com/ghostbsd/ghostbsd-ports.git -cd ghostbsd-ports -gitg -``` -W repozytorium możesz również sprawdzić `git-cola` i `git-gui`. - -Jeśli szukasz bardziej kompleksowego rozwiązania, sprawdź [Sublime Merge](https://www.sublimemerge.com/). Jest również kompatybilny z Sublime Text. - -Możesz także sprawdzić wtyczki i funkcje dostępne w swoim IDE/edytorze. Visual Studio Code i Sublime Text, w szczególności, oferują wiele wsparcia dla Gita i GitHub. - -#### devhelp - -Devhelp wyświetla podręczniki referencyjne dla bibliotek deweloperskich zainstalowanych na Twoim komputerze. Dla większości bibliotek dokumentacja jest zawarta w pakiecie -dev lub -doc (na przykład, jeśli pracujesz z GTK3, upewnij się, że zainstalujesz libgtk-3-dev i libgtk-3-doc). - -``` -pkg install devhelp -``` - -Możesz uruchomić DevHelp z menu aplikacji i używać go do przeglądania lub wyszukiwania podręczników referencyjnych bibliotek. Często będziesz musiał sprawdzić składnię lub argumenty konkretnej funkcji. Miło jest mieć dostęp do informacji lokalnie, bez potrzeby przeszukiwania internetu. - -#### d-feet - -Niektóre programy używają DBus do komunikacji z innymi. Używamy d-feet do przeglądania i rozwiązywania problemów z DBus. - -``` -pkg install d-feet -``` - -Dzięki d-feet możesz szybko znaleźć usługę na DBus, przeglądać jej interfejs, a nawet ręcznie wywołać niektóre z jej funkcji. - -#### meld - -Meld to narzędzie do wizualnego porównywania różnic. Pokazuje różnice między dwoma plikami i jest w tym doskonały. - -``` -pkg install meld -``` - -#### Inne Przydatne Narzędzia - -Większość naszej konfiguracji jest przechowywana w dconf, a do przeglądania lub modyfikowania jej używamy `gsettings` (z linii poleceń). Jeśli chcesz robić to graficznie, możesz zainstalować `dconf-editor`. - -``` -pkg install dconf-editor -``` \ No newline at end of file diff --git a/contributor/getting-started.md b/contributor/getting-started.md deleted file mode 100644 index 69dfd4a..0000000 --- a/contributor/getting-started.md +++ /dev/null @@ -1,183 +0,0 @@ -

Getting Started

- -## Requirements - -### Speaking English - -Developers come from all around the World, if you speak English you'll be able to work with anybody. - -You're probably OK if you're here reading this guide. You don't need to be fluent or to have great English, but you need to understand English enough to communicate. - -[](#git) -### Knowing how to use Git - -Git is the version control system we are using to keep track of changes. We are using it all the time and everywhere. - -If you don't know about Git, stop right there, you need to learn it. - -To learn Git, visit [GitHub Docs](https://docs.github.com/en/get-started/quickstart/set-up-git). - -Make sure you are familiar with the concepts of commits, branches, remotes, reverts and rebases. - -### Knowing how to use GitHub - -We are using GitHub to host our Git repositories and to work together on the code. - -You will need to have a GitHub account set up. - -To open a GitHub account, visit [GitHub](https://github.com/). - -You will also need to know how to use GitHub to browse code changes, to fork a project, to make pull requests, etc.. - -To set up your GitHub account properly and learn how to use GitHub, visit the [GitHub Help](https://docs.github.com). - -### Running GhostBSD - -For most projects, you will need a computer running the latest version of GhostBSD. - -You can run an earlier version, or FreeBSD, but if you run the latest GhostBSD build you are guaranteed everything will work. - -## Set Up - -Below explains how to get your computer set up. - -### Create a project Sandbox - -It is a good idea to create a directory for all your development needs, in which you will have sub-directories for each project, or each group of projects. This keeps things tidy and well organized in your computer so it becomes easier to search for code across different projects. - -We commonly call our main development directory “Sandbox” and place it in our home folder. - -``` -mkdir ~/projects/ghostbsd -``` - -Of course, you can call it whatever you want and place it anywhere you want as well. - -## Technologies - -Below is an overview of the technologies we are using. - -### Computer Languages - -We use a variety of computer languages in GhostBSD. - -You don't need to know them all and you don't need to know them well. It really depends on which project you want to work and what you want to achieve. - -Here are the languages we use the most. - -#### Python - -Most software applications and most configuration tools are also written in Python. - -The advantage of Python is that it is easy to learn and fast to develop with. - -#### C - -Many software applications and most libraries are written in C. - -The C language is low-level, hard to master and tedious to develop with, but it gives fast performance and it is the most supported language in FreeBSD almost everything is accessible from C. - -#### Bourne shell script - -Most scripts in the FreeBSD are using [Bourne shell(sh)](https://en.wikipedia.org/wiki/Bourne_shell) scrip. Some GhostBSD tools like ghostbsd-build and xconfig are written in Bourne shell. - -### GNOME Toolkit and libraries - -All our user interfaces use [GTK3](https://docs.gtk.org/gtk3/) toolkit. - -Our development relies heavily on the GNOME libraries, in particular we use GLib and GObject lot. - -We are mostly using Python and we access them via [GObject Introspection](https://gi.readthedocs.io). - -### Tools - -#### Development environment - -To write and edit code, you can use anything you want. Some people prefer lightweight editors while others prefer full-fledged IDEs. It is a matter of taste. Development is all about fun, so what matters the most is that you love the tools you use. - -If you're not sure what to use, have a look around and try a few editors/IDE until you find your favorite one. - -Eric uses [Sublime Text](https://www.sublimetext.com/). - -``` -sudo pkg install linux-sublime3 -``` -or -``` -sudo pkg install linux-sublime-text4 -``` - -If you install Sublime, also install its [Package Control](https://packagecontrol.io/installation) and then use it to install the *GitGutter* and *TrailingSpaces* extensions. - -[Visual Studio Code](https://code.visualstudio.com/) is also a very popular choice. - -``` -sudo pkg install vscode -``` - -There are many code editors available under GhostBSD, you can choose your favorite editor. - -#### Version control - -When it comes to version control we are using git and nothing else. All our code is version-controlled with it. - -That being said, you don't necessarily have to use the git command line. - -Here are a few tools you can use to make using git easier. - -gitk is ugly and looks dated (it was developed in Tcl/Tk) but it’s very useful to quickly look at the commit history, to create branches and to cherry pick. - -You can install it from the repositories: -``` -pkg install git-gui -cd ~/projects/ghostbsd -git clone https://github.com/ghostbsd/ghostbsd-ports.git -cd ghostbsd-ports -gitk -``` -From a project directory, simply type gitk to see the history of commits. You can also specify a branch name to see that branch instead, or a subdirectory to only see the history of a particular directory. - -gitg is very similar and it looks better (it’s using Gtk), but its feature set is slightly different. -``` -pkg install gitg -cd ~/projects/ghostbsd -git clone https://github.com/ghostbsd/ghostbsd-ports.git -cd ghostbsd-ports -gitg -``` -From the repository you can also look at git-cola and git-gui. - -If you are looking for a more complete solution, have a look at [Sublime Merge](https://www.sublimemerge.com/). It is also compatible with Sublime Text. - -You can also check the plugins and features available in your IDE/editor. Visual Studio Code, and Sublime Text in particular come with a lot of support for Git and GitHub. - -#### devhelp - -Devhelp shows the reference manuals for the development libraries installed on your computer. For most libraries, the documentation is included in their -dev or -doc package (for instance, if you are working with GTK3, make sure to install libgtk-3-dev and libgtk-3-doc). -``` -pkg install devhelp -``` -You can launch DevHelp from the applications menu and use it to browse or search the libraries reference manuals. You will often need to check the syntax or the arguments of a particular function. It is nice to be able to get the information locally without having to search online. - -#### d-feet - -Some programs use DBus to communicate with others. We use d-feet to browse and troubleshoot DBus. -``` -pkg install d-feet -``` -With d-feet you can quickly find a service on DBus, browse its interface and even call some of its functions manually. - -#### meld - -Meld is a visual diff tool. It shows the differences between two files and it is great at it. -``` -pkg install meld -``` - -#### Other cool tools - -Most of our configuration is stored in dconf and we use gsettings (from the command line) to look at it or modify it. If you want to do it graphically, you can install dconf-editor. - -``` -pkg install dconf-editor -``` \ No newline at end of file diff --git a/contributor/getting-started/index.md b/contributor/getting-started/index.md new file mode 100644 index 0000000..ad995af --- /dev/null +++ b/contributor/getting-started/index.md @@ -0,0 +1,121 @@ +Getting Started +=============== + +## Requirements + +### Communication in English +Our developers hail from all over the globe, and English is the common language we use to collaborate. You don’t need to be fluent, but you should be comfortable enough to understand and communicate ideas effectively. + +If you're reading this, you're likely good to go! + +### Familiarity with Git +We use Git as our version control system to manage changes across all projects. It’s a cornerstone of our workflow, so understanding the basics is essential. + +If you're new to Git, take a moment to learn it before diving in. Check out the [GitHub Docs](https://docs.github.com/en/get-started/start-your-journey) for a solid introduction. Focus on concepts like commits, branches, remotes, and pull requests. + +### A GitHub Account +We host our repositories on GitHub, so you’ll need an account to browse code, fork projects, and submit pull requests. If you don’t have one yet, sign up at [GitHub](https://github.com/) and explore the [GitHub Docs](https://docs.github.com/) to get familiar with the platform. + +### Running GhostBSD +For the best experience, run the latest stable version of GhostBSD on your development machine. While older versions or FreeBSD might work, the latest GhostBSD ensures compatibility with our tools and libraries. + +You can download the latest ISO from the [GhostBSD website](https://www.ghostbsd.org/download) and install it on a physical machine or a virtual environment. + +## Technologies We Use +Here’s a quick rundown of the tools and languages you’ll encounter in GhostBSD development. + +### Programming Languages +GhostBSD projects use a mix of languages depending on the task. You don’t need to master them all—just focus on what’s relevant to your interests. + +#### Python +Most of our user-facing tools—like NetworkMgr, Update Station, and Software Station—are written in Python. It’s easy to learn, quick to develop with, and widely used in our ecosystem. + +#### C +The FreeBSD base system (which GhostBSD builds upon) and many libraries are written in C. It’s a low-level language that requires more effort to work with but delivers excellent performance and deep system access. + +#### Bourne Shell (sh) +Many scripts, including build tools like `ghostbsd-build` and utilities like `xconfig`, are written in Bourne shell script. It’s a lightweight way to automate tasks in the FreeBSD ecosystem. + +### GUI Toolkit and Libraries +Our graphical applications primarily use the [GTK3 toolkit](https://docs.gtk.org/gtk3/). We rely on GNOME libraries like GLib and GObject, often accessed through Python via [GObject Introspection](https://gi.readthedocs.io/). + +#### Configuration Tools +We use `dconf` for storing system configuration. You can interact with it via the `gsettings` command-line tool or the graphical `dconf-editor`. + +Install `dconf-editor` for a visual interface: + +```shell +sudo pkg install dconf-editor +``` + +## Setting Up Your Development Environment + + +Let's get your machine ready for GhostBSD development. + +### Install GhostBSD Base System Development Tools + +GhostBSD doesn’t come with base system development tools preinstalled. To enable compiling code and ports, install the `GhostBSD*-dev` packages. These include essential build tools, compilers, and libraries: + +```shell +sudo pkg install -g 'GhostBSD*-dev' +``` + +### Create a Development Directory +Organize your work in a dedicated directory. A common spot is your home directory: + +```shell +mkdir -p ~/projects/ghostbsd +```` + +Run cd `~/projects/ghostbsd` to jump in and start cloning repos. This keeps your repositories and files tidy. + +### Development Tools +#### Code Editors/IDEs +Pick an editor or IDE you like—there’s no wrong choice! Here are some favorites: + +* **PyCharm Community Edition:** Perfect for Python tools like NetworkMgr with built-in linting and debugging. + ```shell + sudo pkg install pycharm-ce + ``` +* `Visual Studio Code:` Lightweight and extensible, great for general-purpose coding. + ```shell + sudo pkg install vscode + ``` +* `Sublime Text:` Fast and minimalist with great plugin support. + ```shell + sudo pkg install linux-sublime-text4 + ``` +* `Neovim or Vim:` Lightweight for shell scripts or terminal fans. + ```shell + sudo pkg install neovim + ``` + +For Python development, PyCharm stands out with built-in linting. If using another editor, set up a Pylint plugin (e.g., via VS Code’s marketplace or Sublime’s Package Control) to catch issues early. Try one that fits your style! + +#### Version Control Tools +We use Git for version control. Beyond the command line, these graphical tools help: + +* **gitg:** A GTK-based interface to browse Git history. + ```shell + sudo pkg install gitg + cd ~/projects/ghostbsd + git clone https://github.com/ghostbsd/ghostbsd-ports.git + cd ghostbsd-ports + gitg + ``` +* **Sublime Merge:** A sleek Git client, pairs well with Sublime Text. + ```shell + sudo pkg install linux-sublime-merge + ``` + +Clone a repo first (e.g., `git clone https://github.com/ghostbsd/ghostbsd-ports.git`) to explore with these. Many editors also have Git plugins—check yours! + +### How to Contribute to GhostBSD + +We welcome all contributions! To get started, here's how to jump in: + +- **Check the Roadmap**: See our [releases roadmap](https://github.com/orgs/ghostbsd/projects/4) or [current sprint](https://github.com/orgs/ghostbsd/projects/4/views/22) for priorities. +- **Find a Task**: Browse the [issue tracker](https://github.com/orgs/ghostbsd/projects/4/views/21) for bugs or small features, or check [documentation tasks](https://github.com/orgs/ghostbsd/projects/5/views/1) for writing opportunities. +- **Submit Your Work**: Fork the repo, make changes, and send a pull request via GitHub. For docs, contribute to [ghostbsd/documentation](https://github.com/ghostbsd/documentation). +- **Join Us**: Hop into our [Telegram group](https://t.me/ghostbsd_dev) for guidance or to say hi and share what you're working on! \ No newline at end of file diff --git a/contributor/index.md b/contributor/index.md index e69de29..9befd45 100644 --- a/contributor/index.md +++ b/contributor/index.md @@ -0,0 +1,14 @@ +# Contributor Documentation + +Welcome to the GhostBSD contributor documentation! This section is for developers, testers, documentation writers, translators, and anyone else interested in helping improve GhostBSD. + +## How to Contribute + +- [Getting Started](getting-started/index) – Learn how to make your first contribution to GhostBSD. +- [GhostBSD Contributors Guide](contributors-guide/index) – A comprehensive guide covering all aspects of contributing to GhostBSD. +- [Contributor Levels](contributor-levels/index) – Understand the roles and levels of contributors, including member vs. non-member contributions. +- [Contributing Code](code/index) – Guidelines for contributing code, including Python and C development. +- [Contributing to Ports](ports/index) – Help maintain and update our software ports. +- [Contributing Documentation](documentation/index) – Write or improve our documentation, including user and contributor guides. +- [Contributing Translations](translations/index) – Help translate GhostBSD into additional languages. +- [Community Involvement](community/index) – Get involved in our community, including user support and development discussions. \ No newline at end of file diff --git a/index.md b/index.md index 6aa6456..8445403 100644 --- a/index.md +++ b/index.md @@ -24,10 +24,11 @@ user/FAQ ```{toctree} :caption: Contributor Documentation -:maxdepth: 4 +:maxdepth: 2 :hidden: -contributor/get-involved +contributor/index +contributor/getting-started/index contributor/contributor-levels contributor/ghostbsd-contributors-guide ``` @@ -35,7 +36,7 @@ contributor/ghostbsd-contributors-guide ```{toctree} :caption: Upstream Documentation -:maxdepth: 4 +:maxdepth: 2 :hidden: MATE Documentation FreeBSD Documentation @@ -46,7 +47,7 @@ FreeBSD Wiki ```{toctree} :caption: Legal Documentation -:maxdepth: 4 +:maxdepth: 2 :hidden: legal/license