Skip to content

Commit

Permalink
fix broken links and add PR build workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
kenstir committed Sep 13, 2024
1 parent 88cd5ef commit 995b17b
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 20 deletions.
File renamed without changes.
30 changes: 30 additions & 0 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Test deployment

on:
pull_request:
branches:
- main

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20.x
cache: npm

- name: Install dependencies
run: npm ci

- name: Build
run: npm run build
2 changes: 1 addition & 1 deletion docs/admin-guide/fix-caching-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ it doesn't show up in the app. The kinds of things cached are:
* the org tree
* org settings, e.g. `hemlock.events_calendar_url` or `credit.payments.allow`

For details on how the caching is implemented, see [notes on caching](../notes-on-caching.md).
For details on how the caching is implemented, see [notes on caching](notes-on-caching.md).

## How to bust the cache for you yourself right now

Expand Down
14 changes: 14 additions & 0 deletions docs/admin-guide/notes-on-caching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Notes on Caching

The Hemlock app adds 2 parameters to most HTTP GET requests:
* `_ck=clientCacheKey`
* `_sk=serverCacheKey`

***clientCacheKey*** is the app versionCode.
***serverCacheKey*** is the server ils-version appended with hemlock.cache_key.

In this way we force cache misses in three situations:
1. An app upgrade.
2. A server upgrade. Server upgrades sometimes involve incompatible IDL which would otherwise cause OSRF decode crashes.
3. Evergreen admin action. Changing `hemlock.cache_key` on orgID=1 is a final override that is needed only to push out org tree or org URL changes immediately.

18 changes: 0 additions & 18 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,6 @@ const config: Config = {
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'Related Repositories',
items: [
Expand All @@ -104,15 +95,6 @@ const config: Config = {
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/kenstir/hemlock-docs',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Kenneth H. Cox. Built with Docusaurus.`,
},
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/administrators-guide">
to="/docs/admin-guide">
Hemlock Administrator's Guide
</Link>
</div>
Expand Down

0 comments on commit 995b17b

Please sign in to comment.