Commit Graph
17 Commits
Author SHA1 Message Date
Lauri Ojansivu 1af642069c The short CHANGELOG.md starts with the upcoming release's In short.
CHANGELOG.md showed only the five newest releases, so what was about to be
released was only in CHANGELOG-big.md. changelog-short.mjs now puts the
unreleased # Upcoming WeKan ® release first - its In short and a link to
its full section - and the five newest releases below it; right after a
release, when there is no Upcoming yet, none is invented.

CLAUDE.md and AGENTS.md say what "update wekan changelog" means: find the
commits not in the changelog yet, add an Upcoming section when a release
was cut meanwhile, write the entries and the In short into
CHANGELOG-big.md, run changelog-short.mjs, run the changelog tests, and
commit both files.

tests/changelogShort.test.cjs: Upcoming first, whole, above the releases,
its link resolves, and no Upcoming appears after a release.

Thanks to xet7 !
2026-10-30 03:56:11 +02:00
Lauri Ojansivu f1c0db247a CHANGELOG.md is the short changelog, written from CHANGELOG-big.md.
CHANGELOG-big.md is the changelog as it was: # Status, # Upcoming and every
release in full, with its <details> entries. Everything that writes or edits
the changelog uses it - release-all.sh, release-notes.sh and the release
workflow, the commit-link repair in build.sh and fix-changelog-hashes.sh,
the archive, the wrapper, the version scripts - and the release notes'
"More details at ChangeLog" link goes to its section. remote-release.py,
shared with FerretDB and the patch repositories, takes the file from its
config, and only WeKan's names CHANGELOG-big.md.

CHANGELOG.md is new: no Status and no Upcoming, only the In short paragraph
of each of the five newest releases and a link to its full section, in plain
Markdown - no <details>, <summary>, </summary> or </details>, and HTML links
written as Markdown links. releases/changelog-short.mjs writes it;
release-all.sh runs it right after naming the release, so it is in the
release commit, and changelog.sh does too. The Sandstorm App Market keeps
embedding CHANGELOG.md, now the short one.

old-CHANGELOG/'s headers say they moved out of CHANGELOG-big.md. References
to Upcoming or TODO Later in code comments and docs name CHANGELOG-big.md.
CLAUDE.md and AGENTS.md describe both files: CHANGELOG-big.md is written,
CHANGELOG.md is generated and never edited by hand.

tests/changelogShort.test.cjs: CHANGELOG.md is exactly what the generator
writes, the five newest releases with their whole In short, links that
resolve, and none of the four tags or an HTML link; the changelog tests
read CHANGELOG-big.md.

Thanks to xet7 !
2026-10-30 03:29:48 +02:00
Lauri Ojansivu ca2dc5fae5 Sandstorm: build from install.sandstorm.org, and link sandstorm.org everywhere.
v12.69's build-sandstorm in release-all.yml stopped because the
certificate of install.sandstorm.io had expired. It fetches the installer
from install.sandstorm.org, as sandstorm.yml and sandstorm-store.yml
already did, and so does releases/install-sandstorm.sh. That installer
downloads Sandstorm from dl.sandstorm.org and configures a development
server at local.sandstorm.org, so the docs follow: docs, apps, dl, install
and local.sandstorm.io links and addresses become sandstorm.org in the docs,
SECURITY.md, code comments and the accounts-sandstorm README, each URL
checked to answer there. demo.sandstorm.io stays, as it has no sandstorm.org
name; released CHANGELOG sections are records and stay as they are. The
release audit's baseline allows the two code comments' docs.sandstorm.org.

tests/sandstormOrgHosts.test.cjs: every Sandstorm build installs from
install.sandstorm.org, and no tracked file names a sandstorm.io host
outside those kept on purpose; it fails on the old release-all.yml.

Thanks to xet7 !
2026-10-30 00:27:54 +02:00
Lauri Ojansivu b7589737f5 File docs/Features the way the WeKan menus are.
A feature's guide now sits under the menu it is used from, read from the
templates rather than from where somebody once put it: Header-Bar,
All-Boards, Pages, Board-Header (search and every Board View), Board-Sidebar
(Board Settings, Filter, Members, Labels, Archive), Rules, Swimlanes, Lists,
Cards, Member-Settings, Admin-Panel and Login-Page. Topics used from several
menus (editor, history, theme, translations, email, troubleshooting) are in
General.

- Each area has a README mapping its menu entries to their guides and to the
  template or server module that implements them. Board-Header/README.md
  lists all 40 Board View entries with the template boardBody.jade renders;
  five views (Table, Calendar Mode, Time, Timeline, Map) have no guide of
  their own yet and say so.
- Board-View.md listed 25 views while BOARD_VIEWS has 40; it now lists all
  of them with their English labels.
- Pages keep their file names. Where a released changelog links an old path,
  a "# Moved" page stays there and points to the new one; test-menu.sh skips
  folders holding only those.
- Undo was filed under Login; it is General/Undo now.
- Every link in docs, code comments, scripts and tests follows the move;
  docsLinksResolve checks them all.

Tests that read a doc follow it to its new place. boardViewSettings now fails
when Board-View.md or Board-Header/README.md differs from BOARD_VIEWS, or
names a template boardBody.jade does not render.

Thanks to xet7 !
2026-10-16 23:45:35 +03:00
Lauri Ojansivu 5029b65382 Keep CHANGELOG.md under GitHub's 500 KiB Markdown limit, so GitHub shows it.
At 2.1 MB, GitHub showed "Sorry about that, but we can't show files that
are this big right now" for CHANGELOG.md. GitHub renders Markdown up to
500 KiB, shows only plain text above that, and nothing above about 2 MB;
the July to September archives, 683 KB to 2 MB, were shown as text only.

releases/changelog-archive.mjs now cuts by size instead of by month:
CHANGELOG.md keeps Status, Upcoming and the newest releases that fit in
450,000 bytes (345 KB now, two releases), and the rest move to
old-CHANGELOG/<year>/<MM>.md, a month over the same budget continuing in
<MM>-part2.md and on, whose parts link each other. Every archive part now
renders, except v12.13, one release of 537 KB in a part of its own. No
release section is changed: all 1,225 are where they were, byte for byte.

release-all.sh runs the archive after renaming Upcoming, keeping the newest
release, which release-notes.sh reads. tests/changelogArchive.test.cjs fails
when CHANGELOG.md or a part is over the budget. CLAUDE.md and AGENTS.md
describe the size rule instead of the current month.

Thanks to xet7 !
2026-10-10 16:11:51 +03:00
Lauri Ojansivu 2606ab56ba Move swimlane/list resize settings and card settings into Board Settings.
#6680 follow-up. Three reorganizations of where board settings live,
grouped under Board Settings (the board's cog menu), with an <hr> above
and below the new group of three:

- The list-width and swimlane-height resize-lock toggles and the
  board-wide "same width for all lists" toggle move out of the header
  and into Board Settings / Swimlane and Board Settings / List.

- Minicard and Card settings (the shared board-wide settings table) move
  back into Board Settings / Card. They previously lived split across
  the card's own menu ("Show on Card") and the minicard's own menu
  ("Show on Minicard"); both entries, their popups, and the
  cardMenuSource module that only existed to tell those two menus apart
  are removed. A non-admin still reaches the one PERSONAL row in that
  table ("Labels text") through the same entry, via personalOnly.

Swimlane and List stay board-admin only (the resize locks already were);
Card is open to any board member, matching who could reach it before.
All three reuse existing translations ('swimlane', 'list',
'card'/'card-settings') via Popup.open's titleKey rather than adding new
*Popup-title keys.

tests/boardSettingsSwimlaneListCard.test.cjs pins the new layout;
tests/listSwimlaneResizeLock.test.cjs, tests/headerIconsCollapse.test.cjs
and tests/popupTitles.test.cjs are updated for what moved.
2026-09-09 03:32:00 +03:00
Lauri Ojansivu 7290ed0360 Say what _build is, and ignore what is not source in every ignore file
Two build directories exist and their names are one character apart, which is
how one of them got scanned as source by a test earlier today:

  .build/  the RELEASE bundle, from `meteor build .build --directory`.
           .build/bundle is what is deployed, tested and packaged.
  _build/  rspack's compiled output, written by ANY Meteor compile. Meteor reads
           the app's main modules from _build/main-prod/, so it is a HANDOFF,
           not a leftover - which is why .meteorignore must NOT ignore it, as
           the note in that file has said since the Meteor 3.4 migration.

Both are now described where somebody meets them: the build.sh and build.bat
headers, Directory-Structure.md, Build-from-source.md, Meteor-bundle.md,
Build-and-Create-Pull-Request.md (as "what not to add to a pull request"), and
CLAUDE.md/AGENTS.md - the last with the warning that _build holds a bundled
second copy of every source file, so anything walking the repository must skip
it. That is not hypothetical; a source-scanning test read it and reported the
bundler's rewritten imports as a source file breaking a rule.

_build was in .gitignore and .meteorignore only. It is now in .dockerignore,
.eslintignore and .prettierignore too.

The same pass aligned the rest. Nothing in client/, server/, models/, imports/,
config/ or packages/ imports anything from docs/, meta/, old-CHANGELOG/,
openapi/, sandstorm-src/, snap-src/, snap-base-debian/, stacksmith/, releases/,
scripts/, tools/ or secrets/ - checked, not assumed - so Meteor no longer
watches them. It watches what it does not ignore, one inotify watch per
directory, against a per-user limit shared with every other watcher on the
machine: the same limit .tools/ was added for. The Docker context no longer
carries them either, since everything in it is sent to the daemon whether the
image uses it or not.

Four things are deliberately NOT ignored, each for a reason now written down:
config/ is imported by the app in nine places; private/ and public/ are Meteor's
own asset directories; packages/ holds the local Meteor packages; and _build/
breaks the build if ignored. releases/ stays in the Docker context because the
Dockerfile COPYs several scripts out of it.

.meteorignore now also ignores .build/, which answers a warning Meteor prints on
every release build - "The output directory is under your source tree. Your
generated files may get interpreted as source code!" Unlike _build/, nothing
hands .build/ back to the compiler; it is finished output read by the deploy and
test steps.

Thanks to xet7 !
2026-09-04 23:47:14 +03:00
Lauri Ojansivu e9963e8b8a Docs: Directory-Structure.md describes the tree WeKan has now.
It described the tree at commit e2f768c, and had gone on describing it for
years. Two failures, and the second is the larger one:

FOURTEEN LINKS POINTED AT NOTHING. Five files had moved - the manifest into
public/svg-etc, the translations into imports/i18n/data, the migrations into
migrations/, Contributing.md to CONTRIBUTING.md - and seven described files that
no longer exist anywhere: the mixins that were replaced, presence.js,
reactiveTabs.js, fast-render.js, and a monkey patch for a bug fixed upstream.
The moved ones are repointed and the deleted ones removed, because an entry for
a file that is not there sends a reader looking for it.

Every one of the fourteen was written as a full
https://github.com/wekan/wekan/tree/main/... URL rather than a relative path,
which is exactly why none was noticed: a broken relative link is visibly broken
in an editor and on GitHub, while an absolute one looks like a link and 404s
only for the reader who follows it. All 144 relative links were fine.

AND TWO THIRDS OF THE REPOSITORY WAS NOT MENTIONED AT ALL - imports/, packages/,
releases/, tests/, docs/, migrations/, server/lib, server/methods, server/routes,
models/lib, client/features. The page walked through four directories out of
twenty and did not say that was what it was doing, so a reader could not tell
the difference between "not here" and "does not exist".

It now opens with a table of the whole tree, and gains sections for the four
server directories that hold most of the server, models/lib (the pure modules
that let a decision be tested as arithmetic under bare node), client/features
(the list of what the client LOADS - a component not named there is not in the
bundle however finished it is), and the build/release/test tooling.

tests/docsLinksResolve.test.cjs checks both link forms against the tree, and
fails when Directory-Structure.md stops mentioning a top-level source directory -
the silence being the failure that lasted longest.

Thanks to xet7 !
2026-08-16 17:56:41 +03:00
Lauri Ojansivu f0204ae014 Show on Card and Show on Minicard in the menus of the card and the minicard.
Board Settings / Card Settings is a table of twenty-four settings in two
columns - what a card shows, and what a minicard shows - and it lived in one
place only, four clicks from the card whose fields it decides. It is now also
the first entry of the two menus it is about: the opened card's hamburger
offers Show on Card, a minicard's offers Show on Minicard, each followed by a
rule like every other group in those menus.

Both open the SAME popup with the other column hidden by a class, so there is
one list of settings and one set of handlers; a setting added to the table
appears in all three places by itself. The permission is the one Board Settings
already used - a board admin - asked in the menu and again where it acts. The
menu is opened from two places and its data context is the card either way, so
the opener records which hamburger it was in a module-level reactive value
rather than a field on the card document, which a re-render throws away.

"Hide minicard label text" left the right sidebar, where nothing else about a
minicard is, and became the "Labels text" row of the same table, directly under
Labels. It is ticked when the text is SHOWN, which is the default: the stored
flag is a "hidden" one, and reading it straight through would leave the box
unticked for the behaviour a board has out of the box. It is the one personal
row of a board-wide table, so it shows in the minicard's view only, is offered
to everybody, and a reader who is not a board admin gets that row alone.

The move found a bug: the setting was written out three times and the
minicard's own copy only ever wrote localStorage, so a logged-in user toggling
it set something nothing reads. One module reads and writes it now.

The board sidebar's Activities heading had an eye and the words "Show
activities" beside it - one setting with two controls and its own name twice.
It is a caret in front of the heading now, and the heading is the button, which
is what every collapsible section of an opened card already is. Both take the
caret's direction from one function, so it cannot point one way on a card and
another in the sidebar of the same language.

tests/showOnCardMenus.test.cjs pins all of it. The Sandstorm and Scaling docs
name the new route beside the old one, and the developer directory structure
lists the three new client/lib modules.

Thanks to xet7 !
2026-08-14 04:32:04 +03:00
Lauri Ojansivu dcc6c8fe5d Version pane: five tables with a heading each, and what WeKan is installed as.
Admin Panel / Settings / Version was ONE table of 38 rows. The WeKan version,
the OS load average, the DDP transport and a V8 heap counter were the same kind
of thing in it: one flat list, read top to bottom, with no way to jump to the
part you came for.

Five tables now, each under a small heading, in the order somebody debugging
reads them - Platform (what this IS), OS (what it runs on), Meteor (how it talks
to the client: reactivity, reactivity order, DDP transport), Database (type,
versions, commits, storage engine, OpLog, sessions) and Node (version, heap,
memory). Reactivity and DDP moved to Meteor, where they belong: they are how the
client is fed, and they were the two rows most often read as database settings.
Whether an OpLog EXISTS stays with the database, because that is a property of
it. No row was dropped; a test lists all 38 by name and requires each to still
be shown.

NEW ROW: what WeKan is installed as - bundle.zip, Snap, Docker or Sandstorm. It
is the first thing a support answer turns on, and the pane never said it: the
same version keeps its data somewhere else, carries a different database and
gives the admin different reach in each of the four. models/lib/platformPackaging.js
detects it, most-specific-first: an explicit WEKAN_PACKAGING wins (a packaging
that knows what it is should say so, and it is how a future .deb or chart names
itself), then Sandstorm, then snapd's own SNAP/SNAP_NAME, then a container
runtime's marker file, then the bundle. Sandstorm and Snap are asked BEFORE the
container markers on purpose: a grain is a container, and a confined snap can
look like one, so the other order answers "Docker" for both. It claims nothing
it cannot know - there is no "source checkout" answer, because a `meteor run`
and an unpacked bundle are identical from inside the process.

The detection is a pure function taking the environment, the Sandstorm flag and
a file-exists callback, so all nine of its tests run here without a snap, a
container or a grain - including that an empty SNAP is not a snap, that an empty
WEKAN_PACKAGING falls through rather than blanking the field, and that an
unreadable root answers bundle.zip instead of throwing an admin's Version page
away.

The headings are SMALLER than the pane title above them, and a test compares the
two font sizes rather than trusting the CSS to stay that way: five headings at
1.25rem would read as five pane titles and "Version" would be lost among them,
and an unstyled h3 - the browser default here - is larger still. Six new English
strings; the other languages fall back to English until translated, as usual.

tests/clientBundleImports.test.cjs caught the new stylesheet before it could
matter: package.json sets meteor.mainModule, so a .css nobody imports is simply
not in the bundle. It is imported from client/features/settings.js now.

Thanks to xet7 !
2026-08-10 03:40:12 +03:00
Lauri Ojansivu f628a69889 Reorganized docs Platforms etc.
Thanks to xet7 !
2026-08-03 13:07:12 +03:00
Lauri OjansivuandClaude Opus 4.8 b912ddb6f5 docs: convert internal wiki/repo links from https URLs to relative paths
The GitHub wiki is disabled and its content was migrated into docs/, so every
https://github.com/wekan/wekan/wiki/... link now redirects to the repo home and
is broken. Rewrite all internal links in docs/ to relative paths:

- wiki/<Page> -> relative path to the corresponding docs/ file (renamed pages
  mapped explicitly: Caddy-Webserver-Config->Webserver/Caddy.md, Wekan-Markdown
  ->Features/Markdown/Markdown.md, REST-API-Role->API/Role.md, etc.)
- wiki home -> docs/README.md
- blob|tree|raw/main|master/<path> -> relative path (anchors and #Lxx line
  ranges preserved; bare URLs wrapped as [name](path) so they stay clickable)

Kept absolute (intentionally not flattened to the current ref):
- ref-pinned links (edge, devel, version tags, commit hashes)
- links whose target no longer exists in the tree

wiki/issues -> the GitHub issues tracker URL (external). 436 links across 113
files; verified no wiki links remain and no broken relative links introduced.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-21 20:43:36 +03:00
Lauri Ojansivu f6d8befb56 Moved website to separate repo. Moved docs2 back to docs.
Thanks to xet7 !
2026-04-28 11:59:16 +03:00
Lauri Ojansivu 1c0d8e9964 Moved docs to docs2, and wekan.fi to docs, to be able publish with GitHub Pages.
Thanks to xet7 !
2026-04-16 14:36:10 +03:00
Martin Filser c925a27870 Fixing opening cards and slow performance of closing cards
Fixes: #5533
Fixes: #5548

Revert "Switch from kadira:flow-router to ostrio:flow-router-extra"

This reverts commit 718c1a393d.
2024-10-22 21:45:36 +02:00
Denis Perov 718c1a393d Switch from kadira:flow-router to ostrio:flow-router-extra 2024-09-23 19:25:55 +03:00
Lauri Ojansivu ce89ff4833 Reorganized Docs. In Progress. 2024-06-27 11:08:43 +03:00