From d956193251739026e1d52f83a45648cb4b6de110 Mon Sep 17 00:00:00 2001 From: Cody McGinnis Date: Sun, 7 Mar 2021 10:47:44 -0500 Subject: change "Under Development" to "Beta Testing" --- .../features/beta-testing/pr-repo-branch.png | Bin 0 -> 75255 bytes .../assets/features/beta-testing/repo-branch.png | Bin 0 -> 63626 bytes .../docs/assets/features/beta-testing/repo-url.png | Bin 0 -> 78981 bytes .../features/under-development/pr-repo-branch.png | Bin 75255 -> 0 bytes .../features/under-development/repo-branch.png | Bin 63626 -> 0 bytes .../assets/features/under-development/repo-url.png | Bin 78981 -> 0 bytes docs/docs/features/beta-testing.md | 100 +++++++++++++++++++++ docs/docs/features/under-development.md | 100 --------------------- docs/sidebars.js | 2 +- 9 files changed, 101 insertions(+), 101 deletions(-) create mode 100644 docs/docs/assets/features/beta-testing/pr-repo-branch.png create mode 100644 docs/docs/assets/features/beta-testing/repo-branch.png create mode 100644 docs/docs/assets/features/beta-testing/repo-url.png delete mode 100644 docs/docs/assets/features/under-development/pr-repo-branch.png delete mode 100644 docs/docs/assets/features/under-development/repo-branch.png delete mode 100644 docs/docs/assets/features/under-development/repo-url.png create mode 100644 docs/docs/features/beta-testing.md delete mode 100644 docs/docs/features/under-development.md diff --git a/docs/docs/assets/features/beta-testing/pr-repo-branch.png b/docs/docs/assets/features/beta-testing/pr-repo-branch.png new file mode 100644 index 0000000..68856d0 Binary files /dev/null and b/docs/docs/assets/features/beta-testing/pr-repo-branch.png differ diff --git a/docs/docs/assets/features/beta-testing/repo-branch.png b/docs/docs/assets/features/beta-testing/repo-branch.png new file mode 100644 index 0000000..741e69a Binary files /dev/null and b/docs/docs/assets/features/beta-testing/repo-branch.png differ diff --git a/docs/docs/assets/features/beta-testing/repo-url.png b/docs/docs/assets/features/beta-testing/repo-url.png new file mode 100644 index 0000000..aed3713 Binary files /dev/null and b/docs/docs/assets/features/beta-testing/repo-url.png differ diff --git a/docs/docs/assets/features/under-development/pr-repo-branch.png b/docs/docs/assets/features/under-development/pr-repo-branch.png deleted file mode 100644 index 68856d0..0000000 Binary files a/docs/docs/assets/features/under-development/pr-repo-branch.png and /dev/null differ diff --git a/docs/docs/assets/features/under-development/repo-branch.png b/docs/docs/assets/features/under-development/repo-branch.png deleted file mode 100644 index 741e69a..0000000 Binary files a/docs/docs/assets/features/under-development/repo-branch.png and /dev/null differ diff --git a/docs/docs/assets/features/under-development/repo-url.png b/docs/docs/assets/features/under-development/repo-url.png deleted file mode 100644 index aed3713..0000000 Binary files a/docs/docs/assets/features/under-development/repo-url.png and /dev/null differ diff --git a/docs/docs/features/beta-testing.md b/docs/docs/features/beta-testing.md new file mode 100644 index 0000000..4328ccb --- /dev/null +++ b/docs/docs/features/beta-testing.md @@ -0,0 +1,100 @@ +--- +title: Beta Testing +sidebar_label: Beta Testing +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +You may find that ZMK does not support a feature or keyboard that you are interesting in using. You may find that someone +has already taken the time to submit the feature you need as a [Pull Request](https://github.com/zmkfirmware/zmk/pulls). If you find the feature you need as a pull request, +this page is for you! + +## Developer Repositories and Branches + +For a developer to submit a pull request to ZMK, they must first clone the original ZMK repository. After they have a copy +of the source code, they may create a feature branch to work within. When they have finished, they will publish the feature +branch and create the pull request. + +### Finding the Repository Page from the Pull Request + +![PR Repository](../assets/features/beta-testing/pr-repo-branch.png) + +### Finding the Repository URL + +![Repository URL](../assets/features/beta-testing/repo-url.png) + +### Finding the Repository Branch + +![Repository URL](../assets/features/beta-testing/repo-branch.png) + +## Testing features + +Testing features will require you to modify the `west.yml` file. You will need to add a new remote for the pull request you +would like to test, and change the selected remote and revision (or branch) for the `zmk` project. + +### Examples + + + + +``` +manifest: + remotes: + - name: zmkfirmware + url-base: https://github.com/zmkfirmware + projects: + - name: zmk + remote: zmkfirmware + revision: main + import: app/west.yml + self: + path: config +``` + + + + +``` +manifest: + remotes: + - name: zmkfirmware + url-base: https://github.com/zmkfirmware + - name: okke-formsma + url-base: https://github.com/okke-formsma + projects: + - name: zmk + remote: okke-formsma + revision: macros + import: app/west.yml + self: + path: config +``` + + + + +``` +manifest: + remotes: + - name: zmkfirmware + url-base: https://github.com/zmkfirmware + - name: mcrosson + url-base: https://github.com/mcrosson + projects: + - name: zmk + remote: mcrosson + revision: feat-behavior-sleep + import: app/west.yml + self: + path: config +``` + + + diff --git a/docs/docs/features/under-development.md b/docs/docs/features/under-development.md deleted file mode 100644 index 486ea5d..0000000 --- a/docs/docs/features/under-development.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Under Development -sidebar_label: Under Development ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -You may find that ZMK does not support a feature or keyboard that you are interesting in using. You may find that someone -has already taken the time to submit the feature you need as a [Pull Request](https://github.com/zmkfirmware/zmk/pulls). If you find the feature you need as a pull request, -this page is for you! - -## Developer Repositories and Branches - -For a developer to submit a pull request to ZMK, they must first clone the original ZMK repository. After they have a copy -of the source code, they may create a feature branch to work within. When they have finished, they will publish the feature -branch and create the pull request. - -### Finding the Repository Page from the Pull Request - -![PR Repository](../assets/features/under-development/pr-repo-branch.png) - -### Finding the Repository URL - -![Repository URL](../assets/features/under-development/repo-url.png) - -### Finding the Repository Branch - -![Repository URL](../assets/features/under-development/repo-branch.png) - -## Testing features - -Testing features will require you to modify the `west.yml` file. You will need to add a new remote for the pull request you -would like to test, and change the selected remote (or repository) and revision (or branch) for the `zmk` project. - -### Examples - - - - -``` -manifest: - remotes: - - name: zmkfirmware - url-base: https://github.com/zmkfirmware - projects: - - name: zmk - remote: zmkfirmware - revision: main - import: app/west.yml - self: - path: config -``` - - - - -``` -manifest: - remotes: - - name: zmkfirmware - url-base: https://github.com/zmkfirmware - - name: okke-formsma - url-base: https://github.com/okke-formsma - projects: - - name: zmk - remote: okke-formsma - revision: macros - import: app/west.yml - self: - path: config -``` - - - - -``` -manifest: - remotes: - - name: zmkfirmware - url-base: https://github.com/zmkfirmware - - name: mcrosson - url-base: https://github.com/mcrosson - projects: - - name: zmk - remote: mcrosson - revision: feat-behavior-sleep - import: app/west.yml - self: - path: config -``` - - - diff --git a/docs/sidebars.js b/docs/sidebars.js index 4153b30..6761b19 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -14,7 +14,7 @@ module.exports = { "features/displays", "features/encoders", "features/underglow", - "features/under-development", + "features/beta-testing", ], Behaviors: [ "behaviors/key-press", -- cgit v1.2.3