Skip to content

Commit

Permalink
Docs folder standardization and other fixes (#212)
Browse files Browse the repository at this point in the history
  • Loading branch information
luizcmarin committed Apr 22, 2024
1 parent fe72488 commit 9e95e42
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 17 deletions.
8 changes: 4 additions & 4 deletions LICENSE.md
@@ -1,17 +1,17 @@
Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
Copyright © 2008 by Yii Software (<https://www.yiiframework.com/>)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above copyright
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Yii Software nor the names of its
* Neither the name of Yii Software nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Expand Up @@ -14,7 +14,7 @@
"issues": "https://github.com/yiisoft/yii-cycle/issues?state=open",
"forum": "https://www.yiiframework.com/forum/",
"wiki": "https://www.yiiframework.com/wiki/",
"irc": "irc://irc.freenode.net/yii",
"irc": "ircs://irc.libera.chat:6697/yii",
"source": "https://github.com/yiisoft/yii-cycle"
},
"require": {
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/en/installation.md
Expand Up @@ -2,7 +2,7 @@

The preferred way to install this package is through [Composer](https://getcomposer.org/download/):

```bash
```shell
composer require yiisoft/yii-cycle
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/en/reading-schema.md
Expand Up @@ -122,7 +122,7 @@ return [
In order to export schema as PHP file `cycle/schema/php` command could be used.
Specify a file name as an argument and schema will be written into it:

```bash
```shell
cycle/schema/php @runtime/schema.php
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/es/installation.md
Expand Up @@ -2,7 +2,7 @@

La forma preferida de instalar este paquete es a través de [Composer](https://getcomposer.org/download/):

```bash
```shell
composer require yiisoft/yii-cycle
```

Expand Down
4 changes: 1 addition & 3 deletions docs/guide/es/reading-schema.md
Expand Up @@ -13,7 +13,6 @@ Para utilizar varios proveedores de esquemas, se utiliza el proveedor `Cycle\Sch
de agrupación. Puede configurar este proveedor en la sección `schema-providers` en el archivo `config/params.php`.
Los proveedores de esquemas deben estar organizados de la siguiente manera, los proveedores de caché deben estar al principio de la lista y los proveedores de esquemas de origen al final.


## Esquema basado en atributos de entidades

Por defecto, el esquema se construye basado en los atributos que están en las entidades de su proyecto.
Expand All @@ -27,7 +26,6 @@ Para obtener un esquema del transportador se usa la clase `FromConveyorSchemaPro
El proceso de construcción de esquemas a partir de atributos es relativamente pesado en términos de rendimiento. Por lo tanto, en caso de
usar atributos es una buena idea usar el caché de esquemas.


## Esquemas desde caché

La lectura y escritura de un esquema desde y hacia la caché ocurre en `Cycle\Schema\Provider\SimpleCacheSchemaProvider`.
Expand Down Expand Up @@ -123,7 +121,7 @@ return [
Para exportar el esquema como archivo `PHP` se puede utilizar el comando `cycle/schema/php`.
Especifique el nombre del archivo como argumento y el esquema se escribirá en él:

```bash
```shell
cycle/schema/php @runtime/schema.php
```

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/pt-BR/installation.md
Expand Up @@ -2,8 +2,8 @@

A forma preferida de instalar este pacote é através do [Composer](https://getcomposer.org/download/):

```bash
compositor requer yiisoft/yii-cycle
```shell
composer require yiisoft/yii-cycle
```

## Configurando o pacote
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/pt-BR/reading-schema.md
Expand Up @@ -122,7 +122,7 @@ return [
Para exportar o esquema como arquivo PHP, o comando `cycle/schema/php` pode ser usado.
Especifique um nome de arquivo como argumento e o esquema será gravado nele:

```bash
```shell
cycle/schema/php @runtime/schema.php
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/ru/installation.md
Expand Up @@ -2,7 +2,7 @@

Предпочтительнее установить этот пакет через [Composer](https://getcomposer.org/download/):

```bash
```shell
composer require yiisoft/yii-cycle
```

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/ru/reading-schema.md
Expand Up @@ -8,7 +8,7 @@ Cycle ORM в своей работе полагается на схему — о
Посмотреть используемую в вашем проекте схему вы можете с помощью консольной команды `cycle/schema`.

В пакете `yii-cycle` схему из разных источников предоставляют разные поставщики, реализующие интерфейс
`Cycle\Schema\Provider\SchemaProviderInterface`.
`Cycle\Schema\Provider\SchemaProviderInterface`.

Для того, чтобы последовательно использовать несколько поставщиков схемы, используется группирующий поставщик
`Cycle\Schema\Provider\Support\SchemaProviderPipeline`, который можно сконфигурировать в секции `schema-providers`
Expand Down Expand Up @@ -124,7 +124,7 @@ return [
Для экспорта схемы в виде PHP можно воспользоваться консольной командой `cycle/schema/php`.
Укажите первым параметром имя файла и схема запишется в него:

```bash
```shell
cycle/schema/php @runtime/schema.php
```

Expand Down

0 comments on commit 9e95e42

Please sign in to comment.