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

chore(developer): consolidate external links in Developer messages #10918

Merged
merged 3 commits into from
Mar 5, 2024

Conversation

mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Mar 4, 2024

Establishes keyman-urls.ts as a single place for any links to external websites.

I searched all .ts files in Keyman Developer source and replaced references to websites with function calls here. Note that the names of individual functions within this class can be easily changed as needed, as the hard part was the consolidation.

@keymanapp-test-bot skip

Establishes keyman-urls.ts as a single place for any links to external
websites.

I searched all .ts files in Keyman Developer source and replaced
references to websites with function calls here. Note that the names of
individual functions within this class can be easily changed as needed,
as the hard part was the consolidation.
@mcdurdin mcdurdin requested a review from darcywong00 as a code owner March 4, 2024 05:40
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Mar 4, 2024

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

static readonly FILE_TYPE = (ext: string) => `${KeymanUrls.HELP_KEYMAN_COM}/developer/current-version/reference/file-types/${ext}`;
static readonly KMN_REF = (topic: string) => `${KeymanUrls.HELP_KEYMAN_COM}/developer/language/reference/${topic}`;
static readonly HELP_KEYBOARD = (id: string) => `${KeymanUrls.HELP_KEYMAN_COM}/keyboard/${id}`;
static readonly HELP_MODEL = (id: string) => `${KeymanUrls.HELP_KEYMAN_COM}/model/${id}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Is /model a TODO?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't understand the question?

Copy link
Contributor

Choose a reason for hiding this comment

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

I thought help documentation for models aren't on help.keyman.com yet.

Copy link
Member Author

Choose a reason for hiding this comment

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

Gotcha. The link was already there in .model_info files, so this doesn't change anything from Developer side. The TODO remains somewhere, doesn't need to be tracked here.

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

Base automatically changed from docs/developer/kmc-ldml-docs to beta March 5, 2024 09:05
@mcdurdin mcdurdin merged commit 310504a into beta Mar 5, 2024
4 checks passed
@mcdurdin mcdurdin deleted the chore/developer/consolidate-help-links branch March 5, 2024 09:07
@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 17.0.282-beta

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

Successfully merging this pull request may close these issues.

None yet

3 participants