docs: initial COSI docs website #16

shanduur · 2025-02-07T14:53:21Z

This PR introduces COSI documentation website. It can be manually deployed, or via release tags v*. Prerelease tags are ignored (see runs).

TODO:

mdBook boilerplate;
GitHub Action;
Copy content from old website (if applicable);
Write initial docs;

k8s-ci-robot · 2025-02-07T14:53:25Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur · 2025-02-07T16:20:48Z

Manually triggered WIP docs can be found on my fork: https://shanduur.github.io/container-object-storage-interface/

anurag4DSB

Thank you for the documentation; it LGTM.
I added a comment for a minor change for Scality Object Storage.
We have 2 object storage solutions, RING and ARTESCA and Scality COSI driver is compatible with AWS and AWS S3 and IAM compatible storage solutions.

docs/src/drivers.md

Co-authored-by: Anurag Mittal <info@anuragmittal.com>

anurag4DSB

Thanks for the changes, LGTM :)

docs/src/drivers.md

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

docs/src/api/out.md

Makefile

.github/workflows/docs.yaml

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

Makefile

BlaineEXE · 2025-03-12T14:19:00Z

Makefile

-CHAINSAW_VERSION ?= $(shell grep 'github.com/kyverno/chainsaw ' ./hack/tools/go.mod | cut -d ' ' -f 2)
-CTLPTL_VERSION ?= $(shell grep 'github.com/tilt-dev/ctlptl ' ./hack/tools/go.mod | cut -d ' ' -f 2)
-GOLANGCI_LINT_VERSION ?= $(shell grep 'github.com/golangci/golangci-lint ' ./hack/tools/go.mod | cut -d ' ' -f 2)
-KIND_VERSION ?= $(shell grep 'sigs.k8s.io/kind ' ./hack/tools/go.mod | cut -d ' ' -f 2)
-KUSTOMIZE_VERSION ?= $(shell grep 'sigs.k8s.io/kustomize/kustomize/v5 ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+CHAINSAW_VERSION      ?= v0.2.11
+CRD_REF_DOCS_VERSION  ?= v0.1.0
+CTLPTL_VERSION        ?= v0.8.35
+GOLANGCI_LINT_VERSION ?= v1.61.0
+KIND_VERSION          ?= v0.24.0
+KUSTOMIZE_VERSION     ?= v5.5.0
+MDBOOK_VERSION        ?= v0.4.45


Is dependabot managing these in the makefile?

No, but while updating them, I had some conflict in the dependencies (which are shared in go.mod). It’s worth exploring how can we manage the dependencies without sharing their dependencies.

Makefile

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

BlaineEXE

/lgtm
/approve

k8s-ci-robot · 2025-03-21T22:02:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: anurag4DSB, BlaineEXE, shanduur

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [BlaineEXE,shanduur]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 7, 2025

k8s-ci-robot requested review from BlaineEXE and saad-ali February 7, 2025 14:53

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 7, 2025

shanduur force-pushed the docs branch from d9185ab to 6915c5d Compare February 7, 2025 15:02

docs: initial boilerplate for COSI docs website

06ee293

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur force-pushed the docs branch from 6915c5d to 06ee293 Compare February 7, 2025 15:23

feat: add pages workflow

cd70ec0

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 7, 2025

shanduur changed the title ~~docs: initial boilerplate for COSI docs website~~ docs: initial COSI docs website Feb 7, 2025

anurag4DSB reviewed Feb 10, 2025

View reviewed changes

docs/src/drivers.md Outdated Show resolved Hide resolved

fix: apply Scality suggestin

a58d3fe

Co-authored-by: Anurag Mittal <info@anuragmittal.com>

anurag4DSB approved these changes Feb 10, 2025

View reviewed changes

datamattsson reviewed Feb 19, 2025

View reviewed changes

docs/src/drivers.md Outdated Show resolved Hide resolved

docs: added few other sections

f2ba462

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 28, 2025

shanduur force-pushed the docs branch from ecb6638 to 5f33361 Compare March 1, 2025 14:24

feat: fetch binary release of mdbook

40867d0

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur force-pushed the docs branch from 5f33361 to 40867d0 Compare March 1, 2025 14:25

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 1, 2025

shanduur force-pushed the docs branch from de0e723 to 40867d0 Compare March 1, 2025 14:39

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 1, 2025

k8s-ci-robot requested a review from xing-yang March 10, 2025 13:40

fix: invalid path

028fbd8

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

BlaineEXE reviewed Mar 11, 2025

View reviewed changes

docs/src/api/out.md Show resolved Hide resolved

BlaineEXE reviewed Mar 11, 2025

View reviewed changes

Makefile Outdated Show resolved Hide resolved

BlaineEXE reviewed Mar 11, 2025

View reviewed changes

Makefile Show resolved Hide resolved

BlaineEXE reviewed Mar 11, 2025

View reviewed changes

.github/workflows/docs.yaml Show resolved Hide resolved

fix: address tooling review comments

3ef2987

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur force-pushed the docs branch from 913b2fc to 3ef2987 Compare March 12, 2025 09:56

feat: display version

f9528d2

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur force-pushed the docs branch from 8fc57d0 to f9528d2 Compare March 12, 2025 10:53

feat: disable build on prerelease tags

c0af796

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur requested a review from BlaineEXE March 12, 2025 11:11

BlaineEXE reviewed Mar 12, 2025

View reviewed changes

Makefile Outdated Show resolved Hide resolved

BlaineEXE reviewed Mar 12, 2025

View reviewed changes

Makefile Outdated Show resolved Hide resolved

shanduur added 3 commits March 12, 2025 16:56

fix: remove at from Makefile

d7fcd83

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

fix: revert image name/tag changes

5f45478

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

fix: install golangci-lint using recommended method

3694bfc

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur force-pushed the docs branch 3 times, most recently from c6f07de to 54b19b8 Compare March 12, 2025 16:51

fix: use branch instead of tag

3f3b230

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

shanduur force-pushed the docs branch from 54b19b8 to 3f3b230 Compare March 12, 2025 16:54

shanduur requested a review from BlaineEXE March 20, 2025 15:15

fix: few typos

df4e5fa

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

BlaineEXE approved these changes Mar 21, 2025

View reviewed changes

k8s-ci-robot assigned BlaineEXE Mar 21, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2025

k8s-ci-robot merged commit 3cad7ae into kubernetes-sigs:main Mar 21, 2025
7 checks passed

docs: initial COSI docs website #16

docs: initial COSI docs website #16

Uh oh!

Conversation

shanduur commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Feb 7, 2025

Uh oh!

shanduur commented Feb 7, 2025

Uh oh!

anurag4DSB left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

anurag4DSB left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BlaineEXE Mar 12, 2025

Choose a reason for hiding this comment

Uh oh!

shanduur Mar 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BlaineEXE left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Mar 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

shanduur commented Feb 7, 2025 •

edited

Loading