diff --git a/README.md b/README.md index 312c67b6c3..35f29dc1ef 100644 --- a/README.md +++ b/README.md @@ -1,149 +1,62 @@ -CakePHP Documentation +Documentação do CakePHP 5.x ===================== -[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgreen.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/) -[![Build Status](https://github.com/cakephp/docs/actions/workflows/ci.yml/badge.svg?branch=4.x)](https://github.com/cakephp/docs/actions/workflows/ci.yml) +## Objetivo -This is the official documentation for the CakePHP project. It is available -online in HTML, PDF and EPUB formats at https://book.cakephp.org. +- Traduzir para português e atualizar os exemplos de código da documentação oficial do CakePHP 5.x +- Enviar os arquivos atualizados para o repositório oficial -Contributing to the documentation is pretty simple. Please read the -documentation on contributing to the documentation over on [the -cookbook](https://book.cakephp.org/5/en/contributing/documentation.html) for -help. You can read all the documentation within as it is just in plain text -files, marked up with ReST text formatting. +## Metodologia -There are two ways for building the documentation: with Docker, or by installing -the packages directly on your OS. +### Execução -Build the Documentation with Docker ------------------------------------ +**Docker** -Docker will let you create a container with all packages needed to build the -docs. You need to have docker installed, see the [official docs of -docker](https://docs.docker.com/desktop/) for more information. +> Build da imagem -### Build the image locally ### - -Starting in the top-level directory, you can build the provided `Dockerfile` -and tag it with the name `cakephp/docs` by running: - -```bash +``` docker build -t cakephp/docs . ``` -This can take a little while, because all packages needs to be downloaded, but -you'll only need to do this once. +> Atualização da documentação -Now that the image is built, you can run all the commands to build the docs: - -##### To build the html: ##### -```bash -docker run -it --rm -v $(pwd):/data cakephp/docs make html ``` -##### To build the epub: ##### -```bash -docker run -it --rm -v $(pwd):/data cakephp/docs make epub -``` -##### To build the latex: ##### -```bash -docker run -it --rm -v $(pwd):/data cakephp/docs make latex -``` -##### To build the pdf: ##### -```bash -docker run -it --rm -v $(pwd):/data cakephp/docs make pdf +docker run -it --rm -v $(pwd):/data cakephp/docs make html ``` -All the documentation will output to the `build` directory. - -Build the Documentation Manually --------------------------------- - -### Installing the needed Packages ### +**PHP** -To build the documentation you'll need to install dependencies using: +> Servidor para validação -```bash -pip install -r requirements.txt +``` +php -S localhost:8020 ``` -*To run the pip command, python-pip package must be previously installed.* - -### Building the Documentation ### +**GIT** -After installing the required packages, you can build the documentation using -`make`. +> Padrão de commit -##### Create all the HTML docs. Including all the languages: ##### -```bash -make html -``` - ##### Create just the English HTML docs: ##### -```bash -make html-en ``` +[refact]: translated (pt/index) + cakephp and PHP versions -##### Create all the EPUB (e-book) docs: ##### -```bash -make epub -``` -##### Create just the English EPUB docs: ##### -```bash -make epub-en -``` +# ou -After making changes to the documentation, you can build the HTML version of the -docs by using `make html` again. This will build only the HTML files that have -had changes made to them. - -### Building the PDF ### - -Building the PDF is a non-trivial task. +[refact]: translated (pt/controllers/components) +``` -1. Install LaTeX - This varies by distribution/OS so refer to your package - manager. You should install the full LaTeX package. The basic one requires - any additional packages to be installed with `tlmgr` -2. Run `make latex-en`. -3. Run `make pdf-en`. +--- -At this point the completed PDF should be in `build/latex/en/CakePHPBook.pdf`. +### Validação -Contributing ------------- +- Verificar em todos os idiomas os exemplos de código +- Verificar a tradução com a versão oficial +- Verificar a tradução com a versão 4.x -There are currently a number of outstanding issues that need to be addressed. -We've tried to flag these with `.. todo::` where possible. To see all the -outstanding todo's add the following to your `config/all.py` +--- -```python -todo_include_todos = True -``` -After rebuilding the HTML content, you should see a list of existing todo items -at the bottom of the table of contents. - -You are also welcome to make and suggestions for new content as commits in a -GitHub fork. Please make any totally new sections in a separate branch. This -makes changes far easier to integrate later on. - -Translations ------------- - -Contributing translations requires that you make a new directory using the two -letter name for your language. As content is translated, directories mirroring -the English content should be created with localized content. For more info, -please, -[click here](https://book.cakephp.org/3/en/contributing/documentation.html#new-translation-language). - -Making Search Work Locally --------------------------- - -* Install elasticsearch. This varies based on your platform, but most - package managers have a package for it. -* Clone the [docs_search](https://github.com/cakephp/docs_search) into a - web accessible directory. -* Modify `searchUrl` in `themes/cakephp/static/app.js` to point at the - baseurl for your docs_search clone. -* Start elasticsearch with the default configuration. -* Populate the search using tooling found in the [cakephp docs builder](https://github.com/cakephp/docs-builder) project. -* You should now be able to search the docs using elasticsearch. +## Status (122 arquivos) +Arquivo | Status | Finalizado +-- | -- | -- +pt/index | concluído | 27/08/2025 +pt/intro | em andamento | \ No newline at end of file diff --git a/pt/index.rst b/pt/index.rst index 5e0e698d97..d1becd7138 100644 --- a/pt/index.rst +++ b/pt/index.rst @@ -1,15 +1,14 @@ Bem-vindo ######### -O CakePHP 4 é um framework de desenvolvimento web que funciona com o PHP 8.0 -(pelo menos |minphpversion|). Leia a seção :doc:`CakePHP num piscar de olhos ` -para ter uma ideia geral dos fundamentos do CakePHP. +O CakePHP 5 é um framework de desenvolvimento web executado em PHP |phpversion| (min. PHP +|minphpversion|). Leia :doc:`CakePHP num piscar de olhos ` para obter uma +introdução aos fundamentos do CakePHP. -O *cookbook* (guia de receitas) do CakePHP é um projeto de documentação -editável e aberto à comunidade. Observe o botão com um ícone de um lápis -no canto direito, ele vai direcioná-lo para o editor online do GitHub -referente a página atual, permitindo que você facilmente contribua com -quaisquer adições, exclusões ou correções para a documentação. +O livro CakePHP é um projeto de documentação aberto e editável pela comunidade. +Observe o botão com o ícone de lápis fixado na parede direita; ele +direcionará você para o editor online do GitHub da página ativa, permitindo que você +contribua com quaisquer adições, exclusões ou correções à documentação. .. container:: offline-download @@ -33,25 +32,19 @@ Se você está com dificuldades, existem vários lugares onde Primeiros passos ================ -Aprender um novo framework pode ser intimidador e excitante ao mesmo tempo. Para -ajudar você nesse processo, nós criamos um *cookbook* recheado de exemplos e -receitas que remetem tarefas rotineiras. Se você está iniciando, deveria começar -com o :doc:`/quickstart` que vai lhe proporcionar um panorama geral sobre o que -o CakePHP tem a oferecer e seu funcionamento. +Aprender um novo framework pode ser intimidador e empolgante ao mesmo tempo. Para +ajudá-lo, criamos um livro de receitas repleto de exemplos e receitas para +concluir as tarefas comuns. Se você é iniciante, comece com o +:doc:`/quickstart`, pois ele lhe dará um rápido tour pelo que +o CakePHP tem a oferecer e como funciona. -Após concluir o Guia de Início Rápido, você pode se aprofundar sobre os -principais elementos existentes em uma aplicação construída com o CakePHP: +Após concluir o tutorial de Início Rápido, você pode revisar os principais elementos de um aplicativo CakePHP: * O :ref:`ciclo de requisição do CakePHP ` -* As :doc:`convenções ` que o CakePHP - utiliza. -* :doc:`Controllers ` lidam com requisições e coordenam seus - *models* com as respostas que sua aplicação gera. -* :doc:`Views ` são a camada de apresentação da sua aplicação. Elas - te oferecem poderosas ferramentas para criar HTML, JSON e as outras saídas - que sua aplicação precisa. -* :doc:`Models ` são o ingrediente principal em qualquer aplicação. Eles - lidam com a validação e a lógica de domínio em sua aplicação. +* As :doc:`convenções ` que o CakePHP utiliza. +* :doc:`Controllers ` lidar com requisições e coordenar seus *modelos* com as respostas que sua aplicação gera. +* :doc:`Views ` são a camada de apresentação da sua aplicação. Elas te oferecem ferramentas poderosas para criar HTML, JSON e outras saídas que sua aplicação precisa. +* :doc:`Modelos ` são o ingrediente principal em qualquer aplicação. Eles lidam com a validação e a lógica de domínio em sua aplicação. .. meta:: :title lang=pt: .. CakePHP book arquivo mestre de documentação, criado por