OpenFn / OpenFn/docs

Add Lightning, Worker and CLI changelogs to the doc site

Open
#732 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

This has been at the back of my mind for years (I'm sure there's a kit issue).

But we should add to docs.openfn.org the changelogs for key products, so that users can get a sense of what is changing and when.

There's currently a changelog at https://openfn.github.io/lightning/changelog.html but I don't know how users are supposed to access that

I know changelogs are a bit technical but that's OK. And I'd love a culture of making sure that changelogs are human readable and useful!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Lightning changelog at https://openfn.github.io/lightning/changelog.html and the docs.openfn.org site. Determine how changelogs for Lightning, Worker, and CLI should be exposed; done means users can find all three from the documentation site and the content is human-readable and useful.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.