oceanbox/Poseidon
6
0
Fork 0
Code Issues 48 Pull Requests 6 Actions Packages Projects Releases 149 Wiki Activity

Migrate User Manual to a SSG #68

New Issue
Open
opened 2025-10-30 08:16:59 +00:00 by mrtz-j · 2 comments
mrtz-j commented 2025-10-30 08:16:59 +00:00 (Migrated from gitlab.com)
Copy Link

Today the user-manual is provided as a separate .pdf, without proper versioning with Poseidon or version-control. This makes it hard to coordinate releases with manual content updates.

I would prefer if the user-manual was provided at maps.oceanbox.io/docs using a Static Site Generator (SSG) based on markdown an checked into Git.

We should agree on a format and SSG.

I've already started converting some of the more textfull pages to markdown.

Current Manual

Today the `user-manual` is provided as a separate `.pdf`, without proper versioning with `Poseidon` or version-control. This makes it hard to coordinate releases with manual content updates. I would prefer if the `user-manual` was provided at `maps.oceanbox.io/docs` using a Static Site Generator (SSG) based on markdown an checked into Git. We should agree on a format and [SSG](https://jamstack.org/generators/). I've already started converting some of the more textfull pages to markdown. [Current Manual](/uploads/eb13691d75a66bf91c665ca525e4b53a/Oceanbox_user_manual.pdf)
mrtz-j commented 2025-10-30 08:17:00 +00:00 (Migrated from gitlab.com)
Copy Link

set status to To do

set status to **To do**
mrtz-j commented 2025-10-30 08:20:38 +00:00 (Migrated from gitlab.com)
Copy Link

changed the description

changed the description
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
customer::all
customer::aqua-kompetanse
customer::bjørøya
customer::cermaq
customer::dnv
customer::framo
customer::lerøy
customer::mowi
customer::novasea
customer::oceanpro
customer::ohs
customer::salmar
customer::scaleaq
customer::stim
customer::synfaring
devel::bug
devel::enhancement
devel::feature
documentation
maps
maps::atlantis
maps::sorcerer
maps::ui
market::demo
market::onboarding
market::presentation
models
models::forecast
models::validation
platform
platform::hpc
platform::k8s
priority
priority::high
priority::low
priority::medium
roadmap
support
support::consulting
support::tech
support::user
tooling
tooling::drifters
bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 wontfix
This won't be fixed
No Label documentation maps
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
juselius mrtz oletytlandsvik renovate-bot simkir sondre
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: oceanbox/Poseidon#68
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?