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

Update development documentation #11917

Merged
merged 2 commits into from
Feb 23, 2024
Merged
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
15 changes: 15 additions & 0 deletions docs/howtos/development_with_kds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Running Kolibri with local Kolibri Design System

Kolibri uses components from [Kolibri Design System](https://github.com/learningequality/kolibri-design-system) (KDS). KDS is installed in Kolibri as a usual npm dependency.

It is sometimes useful to run Kolibri development server linked to local KDS repository, for example to confirm that a KDS update fixes bug observed in Kolibri, when developing new KDS feature in support of Kolibri feature, etc.

For this purpose, Kolibri provides `devserver-with-kds` command that will run the development server with Kolibri using local KDS:

```bash
yarn run devserver-with-kds <kds-path>
```

where `<kds-path>` is the path of the local `kolibri-design-system` repository.

It is recommended to use an absolute KDS path as some developers observed problems when running the command with a relative path.
3 changes: 2 additions & 1 deletion docs/howtos/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ These guides are step by step guides for common tasks in getting started and wor
installing_pyenv
pyenv_virtualenv
nodeenv
another_kolibri_instance
rebasing_a_pull_request
another_kolibri_instance
development_with_kds
2 changes: 2 additions & 0 deletions docs/howtos/rebasing_a_pull_request.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## Rebasing a Pull Request

On certain occasions, it might be necessary to redirect a pull request from the develop branch to the latest release branch, such as `release-v*` (e.g., `release-v0.16.x` when working on version 0.16), or vice versa. This guide outlines the steps for rebasing a feature branch related to your pull request while maintaining a clean commit history.

The demonstration centers on the process of rebasing a feature branch that is directed towards the `develop` branch in your pull request, transitioning it to the most recent release branch, identified as `release-v*`. If the need arises to rebase your pull request in the opposite direction—from `release-v*` to `develop` you can follow the same steps, just adjusting the branch names as indicated in the guide below.
Expand Down
6 changes: 0 additions & 6 deletions docs/howtos/rebasing_a_pull_request.rst

This file was deleted.