grafana / grafana/k6-docs

Split up JSLib from k6-docs repository for versioning purposes

Open
#2,004 1 comment 0 reactions 0 assignees View on GitHub
Area: OSS Content Area: Tooling/Gatsby
Dominant language
Python
Stars
117
Forks
266
Avg merge
4d 11h
Merged PRs (30d)
9

Description

Related to https://github.com/grafana/k6-docs/pull/1979.

[JSLib](https://github.com/grafana/jslib.k6.io) is a set of utility libraries that users can use with k6. Each library has its own set of versions. Currently, in the k6 OSS docs, we have a folder for each k6 version, but other projects are not versioned, including the JSLib libraries, the k6 Operator, and k6 Studio.

Should we consider splitting the documentation for these other projects so we can have docs for each version? What would that look like in grafana.com/docs? What would the workflow look like for updating these docs, and keeping them in sync?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the related k6-docs pull request 1979 and inspect how versioned k6 OSS documentation is organized. Define whether JSLib, the k6 Operator, and k6 Studio should have separate versioned documentation, along with the Grafana.com structure and workflow needed to keep each project synchronized.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.