GoodData.UI is a powerful JavaScript library for building analytical applications on top of the GoodData platform. The best way to start working with Gooddata.UI is to visit sdk.gooddata.com/gooddata-ui.
This repository contains the source code of the documentation.
Install the dependencies, run npm run start and visit http://localhost:5000 in the browser.
Older versions of the documentation are still in the git history, so you may need to checkout older revision first to see version which is no longer present in the master branch.
NOTE: For all the related scripts to work, gooddata-ui-sdk and gooddata-ui-apidocs have to be cloned in the same directory (so that cd ../gooddata-ui-apidocs works from gooddata-ui-sdk).
To preview changes you made in gooddata-ui-sdk, make sure all the projects you changed are build and then run rush start-docs.
This will run the documentation with your changes.
NOTE: if you make some other changes in the code after the documentation site has stared, you need to build it again and run the rush start-docs again – there is no "hot reload".
To release a new version of the apidocs, use the CI job called gooddata-ui-sdk-apidocs-release.
Delete the build with the version number/name and delete the specific version in versions.json in the root.
When making changes to the gooddata-ui-sdk documentation, refer to TSDoc documentation and its rules/limitations. Remember to also avoid JSDoc as it is not compatible with TSDoc and the documentation generator.
(C) 2020-2022 GoodData Corporation
For more information, please see LICENSE.