Skip to content

docs: how to use Alerts #44

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

Merged
merged 4 commits into from
Nov 27, 2024
Merged

Conversation

Meng-Heng
Copy link
Collaborator

follows: #41

This PR is ready for review.

@Meng-Heng Meng-Heng added the documentation Improvements or additions to documentation label Nov 27, 2024
@Meng-Heng Meng-Heng added this to the A18S16 milestone Nov 27, 2024
# GFMAlerts (GitHub Flavored Markdown Alerts)

Here are the syntaxes of the Alerts for Keyman websites. There are 5 types of GFMAlerts:
![GFMAlerts](./assets/img/gfmalerts.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

function _bootstrap_configure_common() {
local BOOTSTRAP_COMMON="$BOOTSTRAP_ROOT/_common"
local ASSET_LOGOS="assets/sil-logos-2024"
local COMMON_FILES=(
builder.inc.sh
docker.inc.sh
keyman-local-ports.inc.sh
JsonApiFailure.php
KeymanHosts.php
KeymanSentry.php
MarkdownHost.php
ImageRandomizer.php
)
local IMG_FILES=(
sil-logo-abbysinica.png
sil-logo-andika-v1.png
sil-logo-andika-v2.png
sil-logo-annapurna.png
sil-logo-tai-heritage-pro.png
)
local common_file=
local img_file=
_bootstrap_echo "Downloading _common files"
rm -rf "$BOOTSTRAP_COMMON"
mkdir -p "$BOOTSTRAP_COMMON"
for common_file in "${COMMON_FILES[@]}"; do
_bootstrap_download "_common/$common_file" "$BOOTSTRAP_COMMON/$common_file"
done
for img_file in "${IMG_FILES[@]}"; do
mkdir -p "$BOOTSTRAP_COMMON/$ASSET_LOGOS/"
_bootstrap_download "_common/$ASSET_LOGOS/$img_file" "$BOOTSTRAP_COMMON/$ASSET_LOGOS/$img_file"
done
_bootstrap_echo "All _common files downloaded"
}

We may need to update to also download the new .png file.
Since the website will pull down this README, the link-checkers would fail if the assets img doesn't exist.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@darcywong00, I rebased this to alerts/v0.12. Can this be merge for testing?

@Meng-Heng Meng-Heng changed the base branch from main to alerts/v0.12 November 27, 2024 06:43
Copy link
Contributor

@darcywong00 darcywong00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@darcywong00 darcywong00 merged commit 324f373 into keymanapp:alerts/v0.12 Nov 27, 2024
1 check passed
Comment on lines +47 to +56
> [!WARNING] DO NOT do this.
> Second line // this will cause a 500 Error

<!-- -->
> [!WARNING] DO NOT do this.
Second line // this will cause a 500 Error

<!-- -->
> [!WARNING] DO NOT do this.
Second line // this will cause a 500 Error
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want 500 errors from Markdown. This needs to be fixed -- Markdown should never cause the server to crash.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants