diff --git a/src/.vitepress/config.js b/src/.vitepress/config.js index 9c118787..acfee48b 100644 --- a/src/.vitepress/config.js +++ b/src/.vitepress/config.js @@ -125,6 +125,8 @@ export default { { text: 'Working with Databases', items: [ + {text: 'Yii DB', link: 'https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md'}, + {text: 'Active Record', link: 'https://github.com/yiisoft/active-record/blob/master/README.md'}, {text: 'Database Migrations', link: '/guide/databases/db-migrations'} ] }, @@ -139,6 +141,17 @@ export default { {text: 'Widgets', link: '/guide/views/widget'} ] }, + { + text: 'Testing', + items: [ + {text: 'Testing Overview', link: '/guide/testing/overview'}, + {text: 'Testing Environment Setup', link: '/guide/testing/environment-setup'}, + {text: 'Unit Tests', link: '/guide/testing/unit'}, + {text: 'Functional Tests', link: '/guide/testing/functional'}, + {text: 'End-to-End Tests', link: '/guide/testing/end-to-end'}, + {text: 'Static Analysis and Mutation Testing', link: '/guide/testing/quality-tools'} + ] + }, { text: 'Tutorial', items: [ @@ -152,6 +165,18 @@ export default { {text: 'Docker in Application Templates', link: '/guide/tutorial/docker'} ] }, + { + text: 'Helpers', + items: [ + {text: 'Arrays', link: 'https://github.com/yiisoft/arrays/'}, + {text: 'Files', link: 'https://github.com/yiisoft/files/'}, + {text: 'Html', link: 'https://github.com/yiisoft/html/'}, + {text: 'Json', link: 'https://github.com/yiisoft/json'}, + {text: 'Network Utilities', link: 'https://github.com/yiisoft/network-utilities/'}, + {text: 'VarDumper', link: 'https://github.com/yiisoft/var-dumper'}, + {text: 'Strings', link: 'https://github.com/yiisoft/strings'} + ] + }, { text: 'Glossary', link: '/guide/glossary' @@ -166,7 +191,8 @@ export default { {text: 'Disabling CSRF Protection', link: '/cookbook/disabling-csrf-protection'}, {text: 'Sentry Integration', link: '/cookbook/sentry-integration'}, {text: 'Working on Windows', link: '/cookbook/working-on-windows'}, - {text: 'Opening Files in PhpStorm', link: '/cookbook/opening-files-in-phpstorm'} + {text: 'Opening Files in PhpStorm', link: '/cookbook/opening-files-in-phpstorm'}, + {text: 'Configuring Xdebug', link: '/cookbook/configuring-xdebug'} ] }, { diff --git a/src/cookbook/index.md b/src/cookbook/index.md index 247a3b9a..f538ab3e 100644 --- a/src/cookbook/index.md +++ b/src/cookbook/index.md @@ -13,7 +13,6 @@ This book conforms to the [Terms of Yii Documentation](https://www.yiiframework. --- - [Preface](preface.md) -- [Structuring code by use-case with vertical slices](organizing-code/structuring-by-use-case-with-vertical-slices.md) - [Making HTTP requests](making-http-requests.md) - [Disabling CSRF protection](disabling-csrf-protection.md) - [Sentry integration](sentry-integration.md) @@ -21,4 +20,5 @@ This book conforms to the [Terms of Yii Documentation](https://www.yiiframework. - [Opening files directly in PhpStorm](opening-files-in-phpstorm.md) - [Configuring Xdebug](configuring-xdebug.md) - [Configuring webservers](configuring-webservers/general.md) +- [Structuring code by use-case with vertical slices](organizing-code/structuring-by-use-case-with-vertical-slices.md) - [Deploying to Docker Swarm](deployment/docker-swarm.md) diff --git a/src/guide/index.md b/src/guide/index.md index 9fb688f2..c3238cf5 100644 --- a/src/guide/index.md +++ b/src/guide/index.md @@ -11,33 +11,34 @@ We release this guide under the [Terms of Yii Documentation](https://www.yiifram - [What do you need to know?](start/prerequisites.md) - [Creating a project](start/creating-project.md) -- [Running applications](start/workflow.md) +- [Application Workflow](start/workflow.md) - [Saying hello](start/hello.md) - [Working with forms](start/forms.md) - [Working with databases](start/databases.md) - [Generating code with Gii](start/gii.md) TODO - [Looking ahead](start/looking-ahead.md) +- [Demo applications](start/demo-apps.md) + +## Key concepts + +- [Aliases](concept/aliases.md) +- [Autoloading](concept/autoloading.md) +- [Configuration](concept/configuration.md) +- [Dependency injection container](concept/di-container.md) +- [Events](concept/events.md) +- [Immutability](concept/immutability.md) ## Application structure - [Application structure overview](structure/overview.md) - [Entry scripts](structure/entry-script.md) - [Application](structure/application.md) -- [Service components](structure/service.md) - [Actions](structure/action.md) -- [Domain](structure/domain.md) - [Middleware](structure/middleware.md) +- [Domain](structure/domain.md) +- [Service components](structure/service.md) - [Packages](structure/package.md) -## Key concepts - -- [Class autoloading](concept/autoloading.md) -- [Dependency injection container](concept/di-container.md) -- [Configuration](concept/configuration.md) -- [Aliases](concept/aliases.md) -- [Events](concept/events.md) -- [Immutability](concept/immutability.md) - ## Handling requests - [Routing and URL generation](runtime/routing.md) @@ -48,14 +49,23 @@ We release this guide under the [Terms of Yii Documentation](https://www.yiifram - [Handling errors](runtime/handling-errors.md) - [Logging](runtime/logging.md) -## Views +## Security -- [View](views/view.md) -- [Template engines](views/template-engines.md) TODO: verify! -- [View injections](views/view-injections.md) -- [Scripts, styles and metatags](views/script-style-meta.md) TODO: verify! -- [Assets](views/asset.md) TODO: verify! -- [Widgets](views/widget.md) TODO: verify! +- [Security overview](security/overview.md) +- [Authentication](security/authentication.md) +- [Authorization](security/authorization.md) TODO: verify and complete! +- [Working with passwords](security/passwords.md) +- [Cryptography](security/cryptography.md) +- [Trusted request](security/trusted-request.md) +- [Best practices](security/best-practices.md) + +## Caching + +- [Caching overview](caching/overview.md) +- [Data caching](caching/data.md) +- [Fragment caching](caching/fragment.md) TODO +- [Page caching](caching/page.md) TODO +- [HTTP caching](caching/http.md) TODO ## Working with databases @@ -63,6 +73,15 @@ We release this guide under the [Terms of Yii Documentation](https://www.yiifram - [Active Record](https://github.com/yiisoft/active-record/blob/master/README.md) - [Migrations](databases/db-migrations.md) TODO: verify/update! +## Views + +- [View](views/view.md) +- [Assets](views/asset.md) TODO: verify! +- [Scripts, styles and metatags](views/script-style-meta.md) TODO: verify! +- [Template engines](views/template-engines.md) TODO: verify! +- [View injections](views/view-injections.md) +- [Widgets](views/widget.md) TODO: verify! + ## Getting data from users - [Creating forms](input/forms.md) TODO @@ -78,25 +97,6 @@ We release this guide under the [Terms of Yii Documentation](https://www.yiifram - [Data providers](output/data-providers.md) TODO - [Data widgets](output/data-widgets.md) TODO -## Security - -- [Security overview](security/overview.md) -- [Authentication](security/authentication.md) -- [Authorization](security/authorization.md) TODO: verify and complete! -- [Working with passwords](security/passwords.md) -- [Cryptography](security/cryptography.md) -- [Best practices](security/best-practices.md) - - -## Caching - -- [Caching overview](caching/overview.md) -- [Data caching](caching/data.md) -- [Fragment caching](caching/fragment.md) TODO -- [Page caching](caching/page.md) TODO -- [HTTP caching](caching/http.md) TODO - - ## REST APIs - [Quick start](rest/quick-start.md) TODO @@ -128,14 +128,14 @@ We release this guide under the [Terms of Yii Documentation](https://www.yiifram ## Special topics - [Console applications](tutorial/console-applications.md) -- [Docker in application templates](tutorial/docker.md) -- [Internationalization](tutorial/i18n.md) TODO - [Mailing](tutorial/mailing.md) - [Performance tuning](tutorial/performance-tuning.md) - [Using Yii with event loop](tutorial/using-with-event-loop.md) - [Using Yii with FrankenPHP](tutorial/using-yii-with-frankenphp.md) - [Using Yii with RoadRunner](tutorial/using-yii-with-roadrunner.md) - [Using Yii with Swoole](tutorial/using-yii-with-swoole.md) +- [Docker in application templates](tutorial/docker.md) +- [Internationalization](tutorial/i18n.md) TODO ## Helpers diff --git a/src/guide/start/workflow.md b/src/guide/start/workflow.md index 5201ded5..4dfe2ec3 100644 --- a/src/guide/start/workflow.md +++ b/src/guide/start/workflow.md @@ -1,4 +1,4 @@ -# Running applications +# Application Workflow After installing Yii, you have a working Yii application. This section introduces the application's built-in functionality,