Procházet zdrojové kódy

Docs: Fixed links for which we know URLs already.

Piotrek Koszuliński před 8 roky
rodič
revize
6d11b8ee2f

+ 1 - 1
docs/builds/guides/development/custom-builds.md

@@ -16,7 +16,7 @@ Some of the reasons for creating custom builds are:
 
 * Adding features which are not included in the existing builds, either from a third party or custom developed.
 * Removing unnecessary features present in a build.
-* Changing the {@link TODO builds/guides/integration/basic-api.html#Creators editor creator}.
+* Changing the {@link builds/guides/integration/basic-api#Creators editor creator}.
 * Changing the editor theme.
 * Changing the localization language of the editor.
 * Enabling bug fixes which are still not a part of any public release.

+ 1 - 1
docs/builds/guides/integration/basic-api.md

@@ -107,4 +107,4 @@ Once destroyed, resources used by the editor instance are released and the origi
 
 ## What’s more?
 
-CKEditor offers a rich API to interact with editors. Check out the {@link TODO API documentation} for more.
+CKEditor offers a rich API to interact with editors. Check out the {@link api/index API documentation} for more.

+ 4 - 4
docs/builds/guides/integration/installation.md

@@ -15,7 +15,7 @@ The goal of installing any of the CKEditor 5 builds is to enable you to use its
 * [CDN](#CDN)
 * [npm](#npm)
 
-Each of the builds has independent release packages. Before starting, you must define which one you are interested in. Check the {@link TODO Overview} page for the list of available builds.
+Each of the builds has independent release packages. Before starting, you must define which one you are interested in. Check the {@link builds/guides/overview Overview} page for the list of available builds.
 
 ### Zip download
 
@@ -29,7 +29,7 @@ The main entry point script will then be available at `<your-path>/ckeditor/buil
 
 Builds can be loaded inside pages directly from our CDN, which is optimized for worldwide super fast download.
 
-Check out the {@link TODO CKEditor 5 Builds CDN website} for a list of URL entry points for the builds API.
+Check out the {@linkTODO CKEditor 5 Builds CDN website} for a list of URL entry points for the builds API.
 
 ### npm
 
@@ -59,7 +59,7 @@ Once downloaded and installed in your application, it is time to make the API av
 <script src="/ckeditor/build/ckeditor.js"></script>
 ```
 
-For a more advanced setup, you may wish to bundle the CKEditor script with other scripts used by your application. See {@link TODO Bundling} for more information about it.
+For a more advanced setup, you may wish to bundle the CKEditor script with other scripts used by your application. See {@linkTODO Bundling} for more information about it.
 
-Once the CKEditor script is loaded, you can {@link TODO use the API} to create editors in your page.
+Once the CKEditor script is loaded, you can {@link builds/guides/integration/basic-api use the API} to create editors in your page.
 

+ 6 - 6
docs/builds/guides/integration/plugins.md

@@ -11,11 +11,11 @@ order: 40
 
 Features in CKEditor are introduced by plugins. In fact, without plugins CKEditor is an empty API with no use. The builds provided with CKEditor 5 are actually predefined collections of plugins, put together to satisfy specific needs.
 
-Plugins provided by the CKEditor core team are available in [npm](https://www.npmjs.com/search?q=ckeditor5) (and [GitHub](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=), too) in form of npm packages. A package may contain one or more plugins (e.g. the [`@ckeditor/ckeditor5-image`](https://www.npmjs.com/package/@ckeditor/ckeditor5-image) packages contains {@link TODOfeatures/image several granular plugins}).
+Plugins provided by the CKEditor core team are available in [npm](https://www.npmjs.com/search?q=ckeditor5) (and [GitHub](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=), too) in form of npm packages. A package may contain one or more plugins (e.g. the [`@ckeditor/ckeditor5-image`](https://www.npmjs.com/package/@ckeditor/ckeditor5-image) packages contains {@link image several granular plugins}).
 
 ## Common use cases
 
-Plugins can be pretty much anything. They are simply code, initialized by the editor if they are configured to be loaded. They can use the richness of the {@link TODO CKEditor 5 Framework API} to enhance the editor or to better integrate it with your application.
+Plugins can be pretty much anything. They are simply code, initialized by the editor if they are configured to be loaded. They can use the richness of the {@linkTODO CKEditor 5 Framework API} to enhance the editor or to better integrate it with your application.
 
 Common use cases for plugins are:
 
@@ -31,13 +31,13 @@ Common use cases for plugins are:
 
 Creating your own plugins is a straightforward task but it requires good knowledge about a few aspects of the CKEditor 5 development environment. The following resources are recommended as a starting point:
 
-* {@link TODO Plugin development guide} in the CKEditor 5 Framework documentation.
-* {@link TODO Creating custom builds} which is necessary to have your plugin included inside a CKEditor 5 build.
+* {@linkTODO Plugin development guide} in the CKEditor 5 Framework documentation.
+* {@link builds/guides/development/custom-builds Creating custom builds} which is necessary to have your plugin included inside a CKEditor 5 build.
 
-A good understanding of the {@link TODO CKEditor 5 Framework} is also very welcome when it comes to creating plugins.
+A good understanding of the {@linkTODO CKEditor 5 Framework} is also very welcome when it comes to creating plugins.
 
 ## Using third-party plugins
 
 A great way to enhance your builds with additional features is by using plugins created by the community. Such plugins are generally available as npm packages, so a quick [search on the "ckeditor5" keyword in npm](https://www.npmjs.com/search?q=ckeditor5) should work as a starting point.
 
-Once you have plugins to be included, just {@link TODO create a custom build} configured to include them.
+Once you have plugins to be included, just {@link builds/guides/development/custom-builds create a custom build} configured to include them.

+ 5 - 5
docs/builds/guides/migrate.md

@@ -13,13 +13,13 @@ When compared to its previous versions, CKEditor 5 should be considered a totall
 
 There is no "drop in" solution for migrating. In this guide we hope to summarize the most important aspects to be taken into consideration before you proceed with installing CKEditor 5.
 
-Before starting, be sure that migrating is your best choice. Check {@link TODO When NOT to use CKEditor 5 Builds}?
+Before starting, be sure that migrating is your best choice. Check {@linkTODO When NOT to use CKEditor 5 Builds}?
 
 ## Installation and integration
 
-The very first aspect that changed with CKEditor 5 is its installation procedure. It became much more modern with introduction of modular patterns, UMD, npm, etc. Check {@link TODO Installation} for more details.
+The very first aspect that changed with CKEditor 5 is its installation procedure. It became much more modern with introduction of modular patterns, UMD, npm, etc. Check {@link builds/guides/integration/installation Installation} for more details.
 
-Once installed, the API for integrating CKEditor with your pages also changed. It is worth checking {@link TODO Basic API} for an introduction.
+Once installed, the API for integrating CKEditor with your pages also changed. It is worth checking {@link builds/guides/integration/basic-api Basic API} for an introduction.
 
 ## Features
 
@@ -40,13 +40,13 @@ The trickiest migration challenge to be faced may be related to custom plugins y
 
 The same may apply for third party plugins which may not have been ported to CKEditor 5 yet.
 
-Check the {@link TODO Plugins guide} for more information on the development of plugins.
+Check the {@linkTODO Plugins guide} for more information on the development of plugins.
 
 ## Themes (skins)
 
 In CKEditor 5, the previous concept of "skins" was reviewed and is now called "themes".
 
-If you have custom skins for CKEditor 4, these skins need to be recreated for CKEditor 5. Fortunately custom theming in CKEditor 5 is much more powerful and simpler than before. For more information, check how to {@link TODO create new themes in the CKEditor 5 Framework documentation}.
+If you have custom skins for CKEditor 4, these skins need to be recreated for CKEditor 5. Fortunately custom theming in CKEditor 5 is much more powerful and simpler than before. For more information, check how to {@linkTODO create new themes in the CKEditor 5 Framework documentation}.
 
 ## Existing data
 

+ 3 - 3
docs/builds/guides/overview.md

@@ -44,7 +44,7 @@ Each build was designed to satisfy as many use cases as possible. They differ in
 
 Every build comes with a default set of features and a default configuration of them. Although the builds try to fit many cases, they may still need to be adjusted in some integrations.
 
-You can override the default configuration of features when creating an instance of the editor. It's also possible to remove some of built-in features through the configuration (if the build comes with too many of them). Read more in the {@linkTODO Configuration guide}.
+You can override the default configuration of features when creating an instance of the editor. It's also possible to remove some of built-in features through the configuration (if the build comes with too many of them). Read more in the {@link builds/guides/integration/configuration Configuration guide}.
 
 If a build doesn't provide all the necessary features or you want create a highly optimized build of editor which will contain only the necessary features, then you need to customize the build or create a brand new one. Check {@linkTODO Custom builds} for details on how to change the default builds to match your preferences.
 
@@ -73,12 +73,12 @@ The following are **some** common use cases:
 
 ### When NOT to use CKEditor 5 Builds?
 
-The {@link TODO CKEditor 5 Framework} should be used, instead of builds, in the following cases:
+The {@linkTODO CKEditor 5 Framework} should be used, instead of builds, in the following cases:
 
 * When you want to create your own text editor and have full control over every aspect of it, from UI to features.
 * When the solution proposed by the builds does not fit your specific use case.
 
-In the following cases {@link TODO CKEditor 4} should be used instead:
+In the following cases {@linkTODO CKEditor 4} should be used instead:
 
 * When compatibility with old browsers is a requirement.
 * If CKEditor 4 contains features that are essential for you, which are not available in CKEditor 5 yet.

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

@@ -13,7 +13,7 @@ If you feel you found an issue in CKEditor, we will be grateful for letting us k
 
 ## Reproduce on official examples
 
-To eliminate the chance that the issue might be caused by some third-party software or your customizations, try to reproduce the issue on the {@link TODO official examples} first.
+To eliminate the chance that the issue might be caused by some third-party software or your customizations, try to reproduce the issue on the {@linkTODO official examples} first.
 
 The examples are always running the latest editor version. Please note that if the problem was fixed in one of the releases that succeeded the version you are using, you will need to upgrade your CKEditor installation as we do not backport fixes.
 

+ 2 - 2
docs/builds/guides/whats-new.md

@@ -71,7 +71,7 @@ The editor is much more lightweight and fast. It brings a fantastic user experie
 
 ## Highly customizable
 
-CKEditor 5 Builds are based on the {@link TODO CKEditor 5 Framework}, which gives powerful customizability and extensibility possibilities.
+CKEditor 5 Builds are based on the {@linkTODO CKEditor 5 Framework}, which gives powerful customizability and extensibility possibilities.
 
 ## Custom data model
 
@@ -79,7 +79,7 @@ A much more efficient data model was designed for CKEditor 5. This makes the dev
 
 ## Collaborative editing
 
-Another important benefit of the custom data model is that it enables the possibility of real-time collaborative editing inside CKEditor by introducing the concepts of "operations" and "operational transformations". Read more about {@link TODO collaboration in the CKEditor 5 Framework documentation}.
+Another important benefit of the custom data model is that it enables the possibility of real-time collaborative editing inside CKEditor by introducing the concepts of "operations" and "operational transformations". Read more about {@linkTODO collaboration in the CKEditor 5 Framework documentation}.
 
 <!-- TODO 3 -->