jenkins-bot has submitted this change and it was merged. Change subject: Clean up CONTRIBUTING.md and README.md for VE core ......................................................................
Clean up CONTRIBUTING.md and README.md for VE core Change-Id: Ia4074af11cdf21678a7939f38e4019ee107d3213 --- M CONTRIBUTING.md M README.md 2 files changed, 16 insertions(+), 39 deletions(-) Approvals: Krinkle: Looks good to me, approved jenkins-bot: Verified diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bdef96..3d0da4c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,16 +37,7 @@ $ grunt --help ``` -To run the tests in a web browser, make sure your MediaWiki install is -[configured](https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing) to -allow running of tests. Set in `LocalSettings.php`: -```php -// https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing -$wgEnableJavaScriptTest = true; -``` - -Then open `http://URL_OF_MEDIAWIKI/index.php/Special:JavaScriptTest/qunit` -(for example, <http://localhost/w/index.php/Special:JavaScriptTest/qunit>). +To run the tests in a web browser, open `modules/ve/test/index.html`. ## Building documentation @@ -79,19 +70,14 @@ Creating the documentation is easy: ```sh $ cd VisualEditor -$ .docs/generate.sh +$ bin/generateDocs.sh ``` -You may need to set `MW_INSTALL_PATH` in your environment to the location of -your mediawiki installation if VisualEditor is not checked out directly in the -mediawiki extensions folder (for example, if you're using a symlink). - The generated documentation is in the `docs/` subdirectory. View the -documentation at -`http://URL_OF_MEDIAWIKI/extensions/VisualEditor/docs/` -(for example, <http://localhost/w/extensions/VisualEditor/docs>). +documentation in a web browser by opening `docs/index.html`. -Note that `jsduck` doesn't support browsing vis the `file:` protocol. +Note that `jsduck` doesn't support live previews when browsing using the +`file:` protocol; this only works when using HTTP/HTTPS. ## VisualEditor Code Guidelines @@ -131,7 +117,7 @@ * @context {Type} Optional text. * @inheritable * @param {Type} name Optional text. -* @emits name +* @fires name * @returns {Type} Optional text. * @chainable * @throws {Type} @@ -168,13 +154,9 @@ before it can be used. Test files: -* VisualEditor.hooks.php in onResourceLoaderTestModules +* modules/ve/test/index.html.template Regular files: * .docs/categories.json in General->Utilities (or somewhere more specific) -* VisualEditor.php in ext.visualEditor.core (or somewhere more specific) -* Run `php maintenance/makeStaticLoader.php --target demo --write-file demos/ve/index.php` -* Run `php maintenance/makeStaticLoader.php --target test --write-file modules/ve/test/index.php` - -makeStaticLoader.php is a maintenance script to automatically generate an HTML document fragment -containing script tags in dependency order (for standalone environments without ResourceLoader). +* modules.json in visualEditor.core (or somewhere more specific) +* Run `grunt build` diff --git a/README.md b/README.md index a8dd1ce..9db1620 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,23 @@ # VisualEditor -VisualEditor provides a visual editor for wiki pages. It is written in +VisualEditor provides a visual editor for HTML pages. It is written in JavaScript and runs in a web browser. -It uses the Parsoid parser to convert wikitext documents to annotated HTML -which the VisualEditor is able to load, modify and emit back to Parsoid at -which point it is converted back into wikitext. - -For more information about these projects, check out the [VisualEditor][] -and [Parsoid][] pages on mediawiki. +For more information about this project, check out the [VisualEditor][] +page on mediawiki. ## Developing and installing -For information on installing VisualEditor on a local wiki, please -see https://www.mediawiki.org/wiki/Extension:VisualEditor +For information on setting up VisualEditor, please see +https://www.mediawiki.org/wiki/VisualEditor/Setup For information about running tests and contributing code to VisualEditor, -see [CODING.md][]. Patch submissions are reviewed and managed with +see [CONTRIBUTING.md][]. Patch submissions are reviewed and managed with [Gerrit][]. There is also [API documentation][] available for the VisualEditor. [VisualEditor]: http://www.mediawiki.org/wiki/VisualEditor -[Parsoid]: http://www.mediawiki.org/wiki/Parsoid -[CODING.md]: CODING.md +[CONTRIBUTING.md]: CONTRIBUTING.md [API documentation]: https://doc.wikimedia.org/VisualEditor/master/ [Gerrit]: https://www.mediawiki.org/wiki/Gerrit -- To view, visit https://gerrit.wikimedia.org/r/102445 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ia4074af11cdf21678a7939f38e4019ee107d3213 Gerrit-PatchSet: 7 Gerrit-Project: VisualEditor/VisualEditor Gerrit-Branch: master Gerrit-Owner: Catrope <[email protected]> Gerrit-Reviewer: Catrope <[email protected]> Gerrit-Reviewer: Jforrester <[email protected]> Gerrit-Reviewer: Krinkle <[email protected]> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
