Parcourir la source

Docs: Updated development guides after monorepo migration.

Anna Tomanek il y a 5 ans
Parent
commit
9afd903854

+ 1 - 1
docs/builds/guides/support/reporting-issues.md

@@ -22,7 +22,7 @@ Most of the issues are reproducible on the demo. If you have a different case th
 
 ## Reporting issues
 
-All issues should be reported in the [CKEditor 5 repository](https://github.com/ckeditor/ckeditor5/issues) on GitHub, except ones that are related to one of the following projects (which have their own issue pages):
+All issues should be reported in the [CKEditor 5 repository](https://github.com/ckeditor/ckeditor5/issues) on GitHub, except ones that are related to one of the following projects (that have their own issue pages):
 
 * [Angular integration](https://github.com/ckeditor/ckeditor5-angular),
 * [React integration](https://github.com/ckeditor/ckeditor5-react),

+ 2 - 2
docs/framework/guides/contributing/contributing.md

@@ -42,12 +42,12 @@ Read more about our {@link framework/guides/contributing/testing-environment tes
 </info-box>
 
 <info-box>
-	[Angular](https://github.com/ckeditor/ckeditor5-angular), [React](https://github.com/ckeditor/ckeditor5-react) and [Vue](https://github.com/ckeditor/ckeditor5-vue) integrations as well as [CKEditor 5 inspector](https://github.com/ckeditor/ckeditor5-inspector) and [dev packages](https://github.com/ckeditor/ckeditor5-dev) are kept in separate repositories. The below steps assume that you want to propose a change in the [main CKEditor 5 repository](https://github.com/ckeditor/ckeditor5).
+	The [Angular](https://github.com/ckeditor/ckeditor5-angular), [React](https://github.com/ckeditor/ckeditor5-react) and [Vue](https://github.com/ckeditor/ckeditor5-vue) integrations as well as [CKEditor 5 inspector](https://github.com/ckeditor/ckeditor5-inspector) and [development tools packages](https://github.com/ckeditor/ckeditor5-dev) are kept in separate repositories. The steps below assume that you want to propose a change in the [main CKEditor 5 repository](https://github.com/ckeditor/ckeditor5).
 </info-box>
 
 Assuming that you would like to propose some changes, these are the steps you should take to create a pull request:
 
-1. Make sure to open a ticket in https://github.com/ckeditor/ckeditor5 describing the issue/feature/problem that you want to solve in your pull request. This can be skipped in case of obvious and trivial changes (typos, documentation, etc.).
+1. Make sure to open a ticket in https://github.com/ckeditor/ckeditor5 describing the issue, feature or problem that you want to solve in your pull request. This can be skipped in case of obvious and trivial changes (typos, documentation, etc.).
 1. Make sure your {@link framework/guides/contributing/development-environment development environment} is ready.
 1. Go to GitHub and [fork the repository](https://help.github.com/articles/fork-a-repo). The forked repository will appear in your GitHub account as `https://github.com/YOUR-USERNAME/ckeditor5`.
 1. Open your terminal, then go to the package ("repository") folder in your development environment:

+ 22 - 21
docs/framework/guides/contributing/development-environment.md

@@ -15,10 +15,10 @@ The CKEditor 5 codebase is divided into multiple [npm](http://npmjs.com/) packag
 
 The main package's GitHub repository also [hosts all other CKEditor5 sub-packages](https://github.com/ckeditor/ckeditor5/tree/master/packages).
 
-You can find all the official packages listed in [CKEditor 5 development repository's README](https://github.com/ckeditor/ckeditor5#packages).
+You can find all the official packages listed in the [CKEditor 5 repository's README](https://github.com/ckeditor/ckeditor5#packages).
 
 <info-box info>
-Prior to version **19.0.0** CKEditor 5 was developed in a multi repository architecture. If you'd like to work with the older multi-repository release, please refer to [older Developer Environment guide](/docs/ckeditor5/19.0.0/framework/guides/contributing/development-environment.html) for multi-repository oriented instructions.
+	Prior to version **19.0.0** CKEditor 5 was developed in a multi-repository architecture. If you would like to work with an older multi-repository release, please refer to the [older Development environment guide](/docs/ckeditor5/19.0.0/framework/guides/contributing/development-environment.html) for multi-repository oriented instructions.
 </info-box>
 
 ## Requirements
@@ -34,7 +34,7 @@ First, you need to install  [Yarn](https://yarnpkg.com/) that will be used for d
 
 It is best to install it globally in your system for an easier use later on:
 
-```bash
+```
 npm install -g yarn
 ```
 
@@ -42,28 +42,28 @@ npm install -g yarn
 
 Then clone the [CKEditor 5 repository](https://github.com/ckeditor/ckeditor5):
 
-```bash
+```
 git clone https://github.com/ckeditor/ckeditor5.git
 cd ckeditor5
 ```
 
 And install all CKEditor 5 packages from the [npm registry](http://npmjs.com/).
 
-```bash
+```
 yarn install
 ```
 
 ## Running tests
 
-In order to run tests you need to use the `test` and `manual` tasks.
+In order to run tests, you need to use the `test` and `manual` tasks.
 
-```bash
+```
 yarn run test --watch --coverage --source-map --files=engine
 ```
 
 or, shorter:
 
-```bash
+```
 yarn run test -- -wcs --files=engine
 ```
 
@@ -73,19 +73,19 @@ This command will run the [`ckeditor5-engine`](https://github.com/ckeditor/ckedi
 
 To create a server for manual tests use the `manual` task:
 
-```bash
+```
 yarn run manual
 ```
 
-To help test localized editors, the task accepts two optional configurations: `--language="en"` and `--additionalLanguages="ar,pl,..."`. The former sets the main language used by test editors. By default it is `"en"` and it in most scenarios you do not need to change it. The later brings more languages to manual tests, e.g. which is helpful when working with {@link features/ui-language#righttoleft-rtl-languages-support right–to–left languages in the user interface}.
+To help test localized editors, the task accepts two optional configurations: `--language="en"` and `--additionalLanguages="ar,pl,..."`. The former sets the main language used by test editors. By default it is `"en"` and in most scenarios you do not need to change it. The latter brings more languages to manual tests, which is helpful e.g. when working with {@link features/ui-language#righttoleft-rtl-languages-support right–to–left languages in the user interface}.
 
 You can read more about the {@link framework/guides/contributing/testing-environment Testing environment}.
 
 ## Generating documentation
 
-To build the documentation you need to run the `docs` task:
+To build the documentation, you need to run the `docs` task:
 
-```bash
+```
 yarn run docs
 ```
 
@@ -93,13 +93,13 @@ The documentation will be available in `build/docs/`.
 
 This task accepts the following arguments:
 
-* `--skip-api` &mdash; Skips building the API documentation (which takes the majority of the total time).
-* `--skip-snippets` &mdash; Skips building live snippets.
-* `--snippets=snippet-name` &mdash; Whitelist snippets to build (accepts glob patterns).
-* `--skip-validation` &mdash; Skips the final link validation.
-* `--watch` &mdash; Runs the documentation generator in a watch mode. It covers guides (it does not cover API docs).
-* `--production` &mdash; Minifies the assets and performs other actions which are unnecessary during CKEditor 5 development.
-* `--verbose` &mdash; Prints out more information.
+* `--skip-api` &ndash; Skips building the API documentation (which takes the majority of the total time).
+* `--skip-snippets` &ndash; Skips building live snippets.
+* `--snippets=snippet-name` &ndash; Whitelists snippets to build (accepts glob patterns).
+* `--skip-validation` &ndash; Skips the final link validation.
+* `--watch` &ndash; Runs the documentation generator in a watch mode. It covers guides but it does not cover API docs.
+* `--production` &ndash; Minifies the assets and performs other actions which are unnecessary during CKEditor 5 development.
+* `--verbose` &ndash; Prints out more information.
 
 Note: These arguments must be passed after additional `--`:
 
@@ -117,9 +117,10 @@ yarn run docs:serve
 
 It is possible to generate a stylesheet containing content styles brought by all CKEditor 5 features. In order to do that, execute:
 
-```bash
+```
 yarn docs:content-styles
 ```
+
 The stylesheet will be saved in the `build/content-styles` folder.
 
 To learn more, refer to the {@link builds/guides/integration/content-styles Content styles} guide.
@@ -132,7 +133,7 @@ By default, CKEditor 5 supports SVG icons found in the `ckeditor5-*/theme/icons`
 
 To remove the excess data and prevent [certain issues](https://github.com/ckeditor/ckeditor5-ui/issues/245), **all new icons should be optimized before joining the code base**. To do that, you can use the `clean-up-svg-icons` script in the [root of the project](#setting-up-the-ckeditor-development-environment), a wrapper for the [SVGO](https://github.com/svg/svgo) tool:
 
-```bash
+```
 cd path/to/ckeditor5
 
 # Optimize all SVG files in the folder.

+ 3 - 3
docs/framework/guides/contributing/testing-environment.md

@@ -31,19 +31,19 @@ It accepts the following arguments that must be passed after the `--` option:
 
 Run all tests with the code coverage check of the [`ckeditor5-core`](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-core/tests) package:
 
-```bash
+```
 yarn run test -c --files=core
 ```
 
 Run and watch the [engine's `view` namespace tests](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-engine/tests/view) and all the tests in [`ckeditor5-typing`](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-typing/tests):
 
-```bash
+```
 yarn run test -cw --files=engine/view,typing
 ```
 
 Run the `bold*.js` tests in the [`ckeditor5-basic-styles`](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-basic-styles/tests) package:
 
-```bash
+```
 yarn run test -cw --files=basic-styles/bold*.js
 ```