Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(analytics-utilities): drop docs build script #1690

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ Monorepo for **open-source** Kong UI components and utilities.
- [ESLint](#eslint)
- [Type Checking](#type-checking)
- [Testing](#testing)
- [File naming convensions](#file-naming-convensions)
- [Preview sandbox build](#preview-sandbox-build)
- [Build for production](#build-for-production)
- [Committing Changes](#committing-changes)
- [Generating type interface documentation](#generating-type-interface-documentation)
- [Enforcing Commit Format](#enforcing-commit-format)
- [Preview components](#preview-components)
- [Running consuming application with local copy of the package](#running-consuming-application-with-local-copy-of-the-package)
- [Moving packages to the public/private repo](#moving-packages-to-the-publicprivate-repo)
Expand Down Expand Up @@ -176,21 +177,6 @@ For more information on different components that compose our commit messages, p

Additionally, CI will use `commitlint` to validate the commits associated with a PR in the `Lint and Validate` job.

### Generating type interface documentation

**This only applies to TypeScript-only packages**

If your package generates **types**, then add a `build:docs` script to your `package.json` file similar to the one in [@kong-ui-public/analytics-utilities](https://github.com/Kong/public-ui-components/blob/main/packages/analytics/analytics-utilties/package.json#L12)

```json
"scripts": {
... other scripts
"build:docs": "{your command for generating docs}"
}
```

Please run the `build:docs` command manually to generate the docs and then commit them to your PR.

### Preview components

You are working on the PR and changing component project. Let's say `@kong-ui-public/i18n`. You want to try to deploy consuming application (`khcp-ui` for example) that uses your changed code without merging your changes to main and publishing new version of `@kong-ui-public/i18n`. Here are the steps:
Expand Down
292 changes: 0 additions & 292 deletions packages/analytics/analytics-utilities/docs/analytics-utils.md

This file was deleted.

Loading
Loading