From e343c2c8d70487127350162c595291e0a3e776fe Mon Sep 17 00:00:00 2001 From: MisRob Date: Fri, 23 Feb 2024 08:57:06 +0100 Subject: [PATCH 1/2] Fix rebasing how to guide not showing --- docs/howtos/rebasing_a_pull_request.md | 2 ++ docs/howtos/rebasing_a_pull_request.rst | 6 ------ 2 files changed, 2 insertions(+), 6 deletions(-) delete mode 100644 docs/howtos/rebasing_a_pull_request.rst diff --git a/docs/howtos/rebasing_a_pull_request.md b/docs/howtos/rebasing_a_pull_request.md index 623e842099e..a1c0f014f81 100644 --- a/docs/howtos/rebasing_a_pull_request.md +++ b/docs/howtos/rebasing_a_pull_request.md @@ -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. diff --git a/docs/howtos/rebasing_a_pull_request.rst b/docs/howtos/rebasing_a_pull_request.rst deleted file mode 100644 index ed587fabca9..00000000000 --- a/docs/howtos/rebasing_a_pull_request.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _rebasing_a_pull_request: - -Rebasing a Pull Request -======================= - -.. mdinclude:: ./rebasing_a_pull_request.md From 2185f00bf828df148b4142d77cedeafdbc890911 Mon Sep 17 00:00:00 2001 From: MisRob Date: Fri, 23 Feb 2024 09:16:36 +0100 Subject: [PATCH 2/2] Add new guide --- docs/howtos/development_with_kds.md | 15 +++++++++++++++ docs/howtos/index.rst | 3 ++- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/howtos/development_with_kds.md diff --git a/docs/howtos/development_with_kds.md b/docs/howtos/development_with_kds.md new file mode 100644 index 00000000000..fff96282703 --- /dev/null +++ b/docs/howtos/development_with_kds.md @@ -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 +``` + +where `` 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. diff --git a/docs/howtos/index.rst b/docs/howtos/index.rst index f83ecf881dc..4e2c544b02e 100644 --- a/docs/howtos/index.rst +++ b/docs/howtos/index.rst @@ -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