Dokumentáció¶

This introductory guide will help you acquire the tools and knowledge needed to contribute to the documentation.

Read the introduction to the reStructuredText language if you are not familiar with it. Then, there are two courses of action to start contributing to the documentation:

For minor changes, such as adding a paragraph or fixing a typo, we recommend using the GitHub interface. This is the easiest and fastest way to submit changes, and it is suitable for non-technical people. Jump directly to the Contributing to the documentation section to get started.
For more complex changes, such as adding a new page, it is necessary to use Git and work from a local copy of the documentation. Follow the instructions in the Környezet beállítása section first to prepare your environment.

Lásd még

Fedezd fel az Odoo-hoz való hozzájárulás egyéb módjait

reStructuredText (RST)¶

The documentation is written in reStructuredText (RST), a lightweight markup language consisting of regular text augmented with markup, which allows including headings, images, notes, and so on. RST is easy to use, even if you are not familiar with it.

Fontos

Be mindful of our content and RST guidelines as you write documentation. This ensures that the documentation stays consistent and facilitates the approval of changes by the Odoo team.

Környezet beállítása¶

Az alábbi utasítások segítenek előkészíteni a környezetét a dokumentáció helyi módosításainak elvégzésére, majd azok GitHub-ra való feltöltésére. Ugorja át ezt a részt, és menjen a Contributing to the documentation részhez, ha már elvégezte ezt a lépést, vagy a GitHub felületéről szeretne módosításokat végrehajtani.

First, create a GitHub account. Odoo uses GitHub to manage the source code of its products, and this is where you will submit your changes.
Új SSH kulcs generálása és regisztrálása a GitHub fiókjában.
Látogasson el a github.com/odoo/documentation oldalra, és kattintson a jobb felső sarokban található Fork gombra, hogy létrehozzon egy forkot (saját másolat) a fiókjában lévő tárról. Ez létrehoz egy másolatot a kódbázisról, amelyen módosításokat végezhet anélkül, hogy a fő kódbázist befolyásolná. Ugorja át ezt a lépést, ha az Odoo-nál dolgozik.
Telepítsd a Git-et. Ez egy parancssori (szöveges felület) eszköz, amely lehetővé teszi a fájlhoz végzett módosítások történetének nyomon követését, és ami még fontosabb, a fájl különböző verzióin való egyidejű munkát. Ez azt jelenti, hogy nem kell aggódnod amiatt, hogy felülírod valaki más függőben lévő munkáját, amikor módosításokat végzel.

Ellenőrizd, hogy a Git telepítési könyvtára szerepel-e a rendszered PATH változójában.

Kövesd a útmutatót a PATH változó frissítéséhez Linux és macOS rendszeren a Git telepítési útvonalával (alapértelmezés szerint /usr/bin/git).
Konfigurálja a Git-et, hogy azonosítsa magát, mint a jövőbeli hozzájárulásai szerzője. Adja meg ugyanazt az email címet, amelyet a GitHub-ra való regisztrációkor használt.
```
$ git config --global user.name "Your Name"
$ git config --global user.email "[email protected]"
```
Klónozza a forrásokat a Git segítségével, és navigáljon a helyi tárolóba.
```
$ git clone [email protected]:odoo/documentation.git
$ cd documentation
```
Konfigurálja a Git-et úgy, hogy a változtatásokat a saját forkjára tolja fel, ne pedig a fő kódbázisra. Az alábbi parancsokban cserélje le a <your_github_account> részt annak a GitHub fióknak a nevére, amelyen a forkot létrehozta. Ha az Odoo-nál dolgozik, ezt a lépést kihagyhatja.
```
$ git remote add dev [email protected]:<your_github_account>/documentation.git
```

Konfigurálja a Git-et, hogy megkönnyítse az együttműködést különböző rendszerekből érkező írók között.

$ git config --global core.autocrlf input
$ git config commit.template `pwd`/commit_template.txt

$ git config --global core.autocrlf true
$ git config commit.template %CD%\commit_template.txt

Install the latest release of Python and pip.
Telepítse a dokumentáció Python függőségeit a pip segítségével.
```
$ pip install -r requirements.txt
```
Ellenőrizze, hogy a Python függőségek telepítési könyvtára szerepel-e a rendszer PATH változójában.

Kövesse a Linux és macOS PATH változó frissítési útmutatót a Python függőségek telepítési útvonalával (alapértelmezés szerint ~/.local/bin).
Telepítse a Make-et.
$ sudo apt install make -y
Follow the guide to install Make on macOS

Kövesse a Make telepítési útmutatót Windows-ra.
Telepítse a pngquant.
You are now ready to make your first contribution with Git.

Contributing to the documentation¶

First, create a GitHub account. Odoo uses GitHub to manage the source code of its products, and this is where you will submit your changes.
Ellenőrizze, hogy a dokumentációt abban a verzióban böngészi, amelyet meg kíván változtatni. A verzió a felső menü legördülő listájából választható ki.
Navigáljon arra az oldalra, amelyet meg szeretne változtatni, és kattintson az oldal jobb felső sarkában található Edit on GitHub gombra.
Kattintson a Fork this repository gombra, hogy létrehozzon egy forkot (saját másolatot) a tárról a fiókjában. Ez létrehoz egy másolatot a kódbázisról, amelyen változtatásokat végezhet anélkül, hogy a fő kódbázist befolyásolná. Ha az Odoo-nál dolgozik, hagyja ki ezt a lépést.
Végezze el a kívánt változtatásokat, ügyelve arra, hogy kövesse a tartalom és RST irányelveket.

Javaslat
Kattintson a Preview changes gombra, hogy hozzájárulását emberi olvashatóságú formátumban tekintse át. Vegye figyelembe, hogy az előnézet nem képes minden jelölést helyesen kezelni. Például a megjegyzések és tippek egyszerű szövegként jelennek meg.
Scroll to the bottom of the page and fill out the small form to propose your changes. In the first text box, write a very short summary of your changes. For instance, „Fix a typo” or „Add documentation for invoicing of sales orders.” In the second text box, explain why you are proposing these changes. Then, click on the Propose changes button.
Tekintse át a módosításait, és kattintson a Create pull request gombra.
Jelölje be a Allow edits from maintainer jelölőnégyzetet. Hagyja ki ezt a lépést, ha az Odoo-nál dolgozik.
Tekintse át a változtatásairól írt összefoglalót, és kattintson ismét a Create pull request gombra.
Az oldal alján ellenőrizze az egyesíthetőségi státuszt, és kezelje az esetleges problémákat.
As soon as your PR is ready for merging, a member of the Odoo team is automatically assigned for review. If the reviewer has questions or remarks, they will post them as comments and you will be notified by email. Those comments must be resolved for the contribution to go forward.
Once your changes are approved, the reviewer merges them and they appear online the next day.

Fontos

Ennek az útmutatónak néhány lépése megköveteli, hogy kényelmesen kezelje a Git-et. Itt talál néhány útmutatót és egy interaktív képzést, ha elakadna valahol.

Most, hogy a környezet be van állítva, elkezdhet hozzájárulni a dokumentációhoz. Egy terminálban navigáljon abba a könyvtárba, ahová a forrásokat klónozta, és kövesse az alábbi útmutatót.

Choose the version of the documentation to which you want to make changes. Keep in mind that contributions targeting an unsupported version of Odoo are not accepted. This guide assumes that the changes target the documentation of Odoo 18, which corresponds to branch 18.0.
Create a new branch starting from branch 18.0. Prefix the branch name with the base branch: 18.0-.... If you work at Odoo, suffix the branch name with your Odoo handle: 18.0-...-xyz.
Example
```
$ git switch -c 18.0-explain-pricelists
```
```
$ git switch -c 18.0-explain-pricelists-xyz
```
Végezze el a kívánt változtatásokat, ügyelve arra, hogy kövesse a tartalom és RST irányelveket.

Compress all PNG images that were added or modified.

$ pngquant path/to/image.png
$ mv path/to/image-fs8.png path/to/image.png

Write a redirect rule for every RST file that were renamed.
Build the documentation with make. Then, open _build/index.html in a web browser to browse the documentation with your changes.

Javaslat
Használja a make help parancsot, hogy megismerje a többi hasznos parancsot.
Kötelezze el a módosításait. Írjon egyértelmű commit üzenetet a Git irányelvek szerint.
```
$ git add .
$ git commit
```
Push your changes to your fork, for which we added the remote alias dev.
Example
```
$ git push -u dev 18.0-explain-pricelists
```
Ha az Odoo-nál dolgozik, közvetlenül a fő kódbázisba tolja fel a változtatásait, amelynek távoli aliasa origin.
Example
```
$ git push -u origin 18.0-explain-pricelists-xyz
```
Nyisson egy PR-et a GitHubon, hogy benyújtsa a módosításait felülvizsgálatra.
1. Lépjen az odoo/documentation kódbázis összehasonlító oldalára.
2. Select 18.0 for the base.
3. Kattintson a compare across forks gombra.
4. Válassza ki a <your_github_account>/odoo lehetőséget a fejlesztési adattárhoz. Cserélje le a <your_github_account> részt annak a GitHub fióknak a nevére, amelyen a forkot létrehozta. Ha az Odoo-nál dolgozik, hagyja ki ezt a lépést.
5. Tekintse át a módosításait, és kattintson a Create pull request gombra.
6. Jelölje be a Allow edits from maintainer jelölőnégyzetet. Hagyja ki ezt a lépést, ha az Odoo-nál dolgozik.
7. Töltse ki a leírást, majd kattintson újra a Create pull request gombra.
Az oldal alján ellenőrizze az egyesíthetőségi státuszt, és kezelje az esetleges problémákat.
As soon as your PR is ready for merging, a member of the Odoo team is automatically assigned for review. If the reviewer has questions or remarks, they will post them as comments and you will be notified by email. Those comments must be resolved for the contribution to go forward.
Once your changes are approved, the reviewer merges them and they appear online the next day.