|
1 | | -CakePHP Documentation |
| 1 | +Documentação do CakePHP 5.x |
2 | 2 | ===================== |
3 | 3 |
|
4 | 4 | [](https://creativecommons.org/licenses/by-nc-sa/4.0/) |
5 | 5 | [](https://github.com/cakephp/docs/actions/workflows/ci.yml) |
6 | 6 |
|
7 | | -This is the official documentation for the CakePHP project. It is available |
8 | | -online in HTML, PDF and EPUB formats at https://book.cakephp.org. |
| 7 | +--- |
9 | 8 |
|
10 | | -Contributing to the documentation is pretty simple. Please read the |
11 | | -documentation on contributing to the documentation over on [the |
12 | | -cookbook](https://book.cakephp.org/5/en/contributing/documentation.html) for |
13 | | -help. You can read all the documentation within as it is just in plain text |
14 | | -files, marked up with ReST text formatting. |
| 9 | +## Objetivo |
15 | 10 |
|
16 | | -There are two ways for building the documentation: with Docker, or by installing |
17 | | -the packages directly on your OS. |
| 11 | +- Traduzir para português e atualizar os exemplos de código da documentação oficial do CakePHP 5.x |
| 12 | +- Enviar os arquivos atualizados para o repositório oficial |
18 | 13 |
|
19 | | -Build the Documentation with Docker |
20 | | ------------------------------------ |
| 14 | +## Metodologia |
21 | 15 |
|
22 | | -Docker will let you create a container with all packages needed to build the |
23 | | -docs. You need to have docker installed, see the [official docs of |
24 | | -docker](https://docs.docker.com/desktop/) for more information. |
| 16 | +### Execução |
25 | 17 |
|
26 | | -### Build the image locally ### |
| 18 | +**Docker** |
27 | 19 |
|
28 | | -Starting in the top-level directory, you can build the provided `Dockerfile` |
29 | | -and tag it with the name `cakephp/docs` by running: |
| 20 | +> Build da imagem |
30 | 21 |
|
31 | | -```bash |
| 22 | +``` |
32 | 23 | docker build -t cakephp/docs . |
33 | 24 | ``` |
34 | 25 |
|
35 | | -This can take a little while, because all packages needs to be downloaded, but |
36 | | -you'll only need to do this once. |
37 | | - |
38 | | -Now that the image is built, you can run all the commands to build the docs: |
| 26 | +> Atualização da documentação |
39 | 27 |
|
40 | | -##### To build the html: ##### |
41 | | -```bash |
42 | | -docker run -it --rm -v $(pwd):/data cakephp/docs make html |
43 | | -``` |
44 | | -##### To build the epub: ##### |
45 | | -```bash |
46 | | -docker run -it --rm -v $(pwd):/data cakephp/docs make epub |
47 | | -``` |
48 | | -##### To build the latex: ##### |
49 | | -```bash |
50 | | -docker run -it --rm -v $(pwd):/data cakephp/docs make latex |
51 | 28 | ``` |
52 | | -##### To build the pdf: ##### |
53 | | -```bash |
54 | | -docker run -it --rm -v $(pwd):/data cakephp/docs make pdf |
| 29 | +docker run -it --rm -v $(pwd):/data cakephp/docs make html |
55 | 30 | ``` |
56 | 31 |
|
57 | | -All the documentation will output to the `build` directory. |
58 | | - |
59 | | -Build the Documentation Manually |
60 | | --------------------------------- |
| 32 | +**PHP** |
61 | 33 |
|
62 | | -### Installing the needed Packages ### |
| 34 | +> Servidor para validação |
63 | 35 |
|
64 | | -To build the documentation you'll need to install dependencies using: |
65 | | - |
66 | | -```bash |
67 | | -pip install -r requirements.txt |
| 36 | +``` |
| 37 | +php -S localhost:8020 |
68 | 38 | ``` |
69 | 39 |
|
70 | | -*To run the pip command, python-pip package must be previously installed.* |
71 | | - |
72 | | -### Building the Documentation ### |
73 | | - |
74 | | -After installing the required packages, you can build the documentation using |
75 | | -`make`. |
| 40 | +**GIT** |
76 | 41 |
|
77 | | -##### Create all the HTML docs. Including all the languages: ##### |
78 | | -```bash |
79 | | -make html |
80 | | -``` |
81 | | - ##### Create just the English HTML docs: ##### |
82 | | -```bash |
83 | | -make html-en |
84 | | -``` |
| 42 | +> Padrão de commit |
85 | 43 |
|
86 | | -##### Create all the EPUB (e-book) docs: ##### |
87 | | -```bash |
88 | | -make epub |
89 | 44 | ``` |
90 | | -##### Create just the English EPUB docs: ##### |
91 | | -```bash |
92 | | -make epub-en |
93 | | -``` |
94 | | - |
95 | | -After making changes to the documentation, you can build the HTML version of the |
96 | | -docs by using `make html` again. This will build only the HTML files that have |
97 | | -had changes made to them. |
| 45 | +[refact]: translated (pt/index) + cakephp and PHP versions |
98 | 46 |
|
99 | | -### Building the PDF ### |
| 47 | +# ou |
100 | 48 |
|
101 | | -Building the PDF is a non-trivial task. |
| 49 | +[refact]: translated (pt/controllers/components) |
| 50 | +``` |
102 | 51 |
|
103 | | -1. Install LaTeX - This varies by distribution/OS so refer to your package |
104 | | - manager. You should install the full LaTeX package. The basic one requires |
105 | | - any additional packages to be installed with `tlmgr` |
106 | | -2. Run `make latex-en`. |
107 | | -3. Run `make pdf-en`. |
| 52 | +--- |
108 | 53 |
|
109 | | -At this point the completed PDF should be in `build/latex/en/CakePHPBook.pdf`. |
| 54 | +### Validação |
110 | 55 |
|
111 | | -Contributing |
112 | | ------------- |
| 56 | +- Verificar em todos os idiomas os exemplos de código |
| 57 | +- Verificar a tradução com a versão oficial |
| 58 | +- Verificar a tradução com a versão 4.x |
113 | 59 |
|
114 | | -There are currently a number of outstanding issues that need to be addressed. |
115 | | -We've tried to flag these with `.. todo::` where possible. To see all the |
116 | | -outstanding todo's add the following to your `config/all.py` |
| 60 | +--- |
117 | 61 |
|
118 | | -```python |
119 | | -todo_include_todos = True |
120 | | -``` |
121 | | -After rebuilding the HTML content, you should see a list of existing todo items |
122 | | -at the bottom of the table of contents. |
123 | | - |
124 | | -You are also welcome to make and suggestions for new content as commits in a |
125 | | -GitHub fork. Please make any totally new sections in a separate branch. This |
126 | | -makes changes far easier to integrate later on. |
127 | | - |
128 | | -Translations |
129 | | ------------- |
130 | | - |
131 | | -Contributing translations requires that you make a new directory using the two |
132 | | -letter name for your language. As content is translated, directories mirroring |
133 | | -the English content should be created with localized content. For more info, |
134 | | -please, |
135 | | -[click here](https://book.cakephp.org/3/en/contributing/documentation.html#new-translation-language). |
136 | | - |
137 | | -Making Search Work Locally |
138 | | --------------------------- |
139 | | - |
140 | | -* Install elasticsearch. This varies based on your platform, but most |
141 | | - package managers have a package for it. |
142 | | -* Clone the [docs_search](https://github.com/cakephp/docs_search) into a |
143 | | - web accessible directory. |
144 | | -* Modify `searchUrl` in `themes/cakephp/static/app.js` to point at the |
145 | | - baseurl for your docs_search clone. |
146 | | -* Start elasticsearch with the default configuration. |
147 | | -* Populate the search using tooling found in the [cakephp docs builder](https://github.com/cakephp/docs-builder) project. |
148 | | -* You should now be able to search the docs using elasticsearch. |
| 62 | +## Status |
149 | 63 |
|
| 64 | +Arquivo | Status | Finalizado |
| 65 | +-- | -- | -- |
| 66 | +pt/index | concluído | 27/08/2025 |
| 67 | +pt/intro | em andamento | |
0 commit comments