Skip to content

Commit

Permalink
Merge pull request #12424 from keymanapp/refactor/common/12347-reorg-…
Browse files Browse the repository at this point in the history
…help

refactor(common): move help into common prod/docs/help folders
  • Loading branch information
mcdurdin authored Sep 26, 2024
2 parents 870dcab + 4b1e137 commit e064024
Show file tree
Hide file tree
Showing 484 changed files with 37 additions and 94 deletions.
4 changes: 2 additions & 2 deletions android/KMAPro/build-play-store-notes.inc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ function generateReleaseNotes() {
# Pad release notes if whatsnew.md doesn't have any line items
# Play Store release notes have a limit of 500 characters
local DEFAULT_RELEASE_NOTE="* Additional bug fixes and improvements"
local FILTERED_LINES=$( grep '^\s*\*.*$' "$KEYMAN_ROOT/android/help/about/whatsnew.md" || [[ $? == 1 ]] ) # Continue if grep has no matches
local FILTERED_LINES=$( grep '^\s*\*.*$' "$KEYMAN_ROOT/android/docs/help/about/whatsnew.md" || [[ $? == 1 ]] ) # Continue if grep has no matches
if [ -z "$FILTERED_LINES" ]; then
FILTERED_LINES="$DEFAULT_RELEASE_NOTE"
builder_warn "Warning: whatsnew.md empty so using default release note: '$FILTERED_LINES'"
fi

# Change IFS to new line
local old_IFS="${IFS}"
IFS=$'\n'
IFS=$'\n'
for line in $FILTERED_LINES
do
local CHARS_IN_RELEASE_NOTES=$( wc -m < "$PLAY_RELEASE_NOTES" )
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions docs/minimum-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ Target Operating System and Platform Versions

### Keyman for Windows

Helpfile: [os.md](../../windows/src/desktop/help/common/os.md)
Helpfile: [os.md](../../windows/docs/help/common/os.md)

### Keyman for macOS

Helpfile: [requirements.md](../../mac/help/about/requirements.md)
Helpfile: [requirements.md](../../mac/docs/help/about/requirements.md)

### Keyman for Linux

Helpfile: [common/index.md](../../linux/help/common/index.md#q-what-linux-distros-will-keyman-work-with)
Helpfile: [common/index.md](../../linux/docs/help/common/index.md#q-what-linux-distros-will-keyman-work-with)

### Keyman iPhone and iPad

Helpfile: [system-requirements.md](../../ios/help/about/system-requirements.md)
Helpfile: [system-requirements.md](../../ios/docs/help/about/system-requirements.md)

### Keyman for Android

Helpfile: [system-requirements.md](../../android/help/about/system-requirements.md)
Helpfile: [system-requirements.md](../../android/docs/help/about/system-requirements.md)

----

Expand Down
10 changes: 5 additions & 5 deletions docs/minimum-versions.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ Target Operating System and Platform Versions

### Keyman for Windows

Helpfile: [os.md](../../windows/src/desktop/help/common/os.md)
Helpfile: [os.md](../../windows/docs/help/common/os.md)

### Keyman for macOS

Helpfile: [requirements.md](../../mac/help/about/requirements.md)
Helpfile: [requirements.md](../../mac/docs/help/about/requirements.md)

### Keyman for Linux

Helpfile: [common/index.md](../../linux/help/common/index.md#q-what-linux-distros-will-keyman-work-with)
Helpfile: [common/index.md](../../linux/docs/help/common/index.md#q-what-linux-distros-will-keyman-work-with)

### Keyman iPhone and iPad

Helpfile: [system-requirements.md](../../ios/help/about/system-requirements.md)
Helpfile: [system-requirements.md](../../ios/docs/help/about/system-requirements.md)

### Keyman for Android

Helpfile: [system-requirements.md](../../android/help/about/system-requirements.md)
Helpfile: [system-requirements.md](../../android/docs/help/about/system-requirements.md)

----

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 7 additions & 7 deletions linux/keyman-config/build-help.sh
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ fi

if [ -n "$generate_help" ]; then
echo "Generating markdown help pages..."
mkdir -p ../help/reference
buildtools/help2md ./km-package-get -o ../help/reference/km-package-get.md -n "Download a Keyman keyboard package" -I maninc/km-package-get.inc
buildtools/help2md ./km-package-install -o ../help/reference/km-package-install.md -n "Install a Keyman keyboard package" -I maninc/km-package-install.inc
buildtools/help2md ./km-config -o ../help/reference/km-config.md -n "Launches Keyman Configuration for installing and showing information about Keyman keyboards" -I maninc/km-config.inc
buildtools/help2md ./km-kvk2ldml -o ../help/reference/km-kvk2ldml.md -n "Convert a Keyman on-screen keyboard file to LDML" -I maninc/km-kvk2ldml.inc
buildtools/help2md ./km-package-list-installed -o ../help/reference/km-package-list-installed.md -n "List installed Keyman keyboard packages" -I maninc/km-package-list-installed.inc
buildtools/help2md ./km-package-uninstall -o ../help/reference/km-package-uninstall.md -n "Uninstall a Keyman keyboard package" -I maninc/km-package-uninstall.inc
mkdir -p ../docs/help/reference
buildtools/help2md ./km-package-get -o ../docs/help/reference/km-package-get.md -n "Download a Keyman keyboard package" -I maninc/km-package-get.inc
buildtools/help2md ./km-package-install -o ../docs/help/reference/km-package-install.md -n "Install a Keyman keyboard package" -I maninc/km-package-install.inc
buildtools/help2md ./km-config -o ../docs/help/reference/km-config.md -n "Launches Keyman Configuration for installing and showing information about Keyman keyboards" -I maninc/km-config.inc
buildtools/help2md ./km-kvk2ldml -o ../docs/help/reference/km-kvk2ldml.md -n "Convert a Keyman on-screen keyboard file to LDML" -I maninc/km-kvk2ldml.inc
buildtools/help2md ./km-package-list-installed -o ../docs/help/reference/km-package-list-installed.md -n "List installed Keyman keyboard packages" -I maninc/km-package-list-installed.inc
buildtools/help2md ./km-package-uninstall -o ../docs/help/reference/km-package-uninstall.md -n "Uninstall a Keyman keyboard package" -I maninc/km-package-uninstall.inc
fi
2 changes: 1 addition & 1 deletion linux/keyman-config/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ builder_describe_outputs \
clean_action() {
rm -rf dist make_deb build ./*.egg-info keyman_config/version.py
find . \( -name __pycache__ -o -name keyman-config.mo \) -exec rm -rf {} +
rm -rf ../help/reference/km-*.md
rm -rf ../docs/help/reference/km-*.md

# Don't delete this file during a package build because they are
# part of the source package. We can't generate it during a package
Expand Down
2 changes: 1 addition & 1 deletion linux/scripts/dist.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ dpkg-source --tar-ignore=*~ \
--tar-ignore=linux/keyman-config/keyman_config/version.py \
--tar-ignore=linux/keyman-config/buildtools/build-langtags.py \
--tar-ignore=__pycache__ \
--tar-ignore=linux/help \
--tar-ignore=linux/docs/help \
--tar-ignore=mac \
--tar-ignore=node_modules \
--tar-ignore=oem \
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions resources/build/build-help.inc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ function _build_help_build() {
local CSS="$KEYMAN_ROOT/resources/build/offline-help-style-spec.txt"
local PLATFORM="$1"

cd "$KEYMAN_ROOT/$PLATFORM/help"
cd "$KEYMAN_ROOT/$PLATFORM/docs/help"
local MD=`find . -name "*.md"`
local DESTHTM="$KEYMAN_ROOT/$PLATFORM/$2"

Expand All @@ -53,9 +53,9 @@ function _build_help_build() {
#
# Copy Images
#
cd "$KEYMAN_ROOT/$PLATFORM/help/"
cd "$KEYMAN_ROOT/$PLATFORM/docs/help/"
mkdir -p "$DESTHTM/${PLATFORM}_images"
cp $KEYMAN_ROOT/$PLATFORM/help/${PLATFORM}_images/* "$DESTHTM/${PLATFORM}_images/"
cp $KEYMAN_ROOT/$PLATFORM/docs/help/${PLATFORM}_images/* "$DESTHTM/${PLATFORM}_images/"
}

#
Expand All @@ -74,7 +74,7 @@ function _build_help_build() {
#
# ### Description
#
# Expects to find .md source under $KEYMAN_ROOT/$platform/help/, and
# Expects to find .md source under $KEYMAN_ROOT/$platform/docs/help/, and
# will write the output .html to $KEYMAN_ROOT/$platform/$output_path.
#
function build_help_html() {
Expand Down
8 changes: 4 additions & 4 deletions resources/build/help-keyman-com.sh
Original file line number Diff line number Diff line change
Expand Up @@ -74,19 +74,19 @@ function upload {
function upload_keyman_help {
case $platform in
android)
upload android/help products/android/$VERSION_RELEASE
upload android/docs/help products/android/$VERSION_RELEASE
;;
ios)
upload ios/help products/iphone-and-ipad/$VERSION_RELEASE
upload ios/docs/help products/iphone-and-ipad/$VERSION_RELEASE
;;
linux)
pushd "$KEYMAN_ROOT/linux/keyman-config" > /dev/null
./build.sh build
popd > /dev/null
upload linux/help products/linux/$VERSION_RELEASE
upload linux/docs/help products/linux/$VERSION_RELEASE
;;
mac)
upload mac/help products/mac/$VERSION_RELEASE
upload mac/docs/help products/mac/$VERSION_RELEASE
;;
windows)
# Note: `/windows/src/desktop/help/build.sh web` must be run first
Expand Down
File renamed without changes.
Loading

0 comments on commit e064024

Please sign in to comment.