Skip to content

docs: initial COSI docs website #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 22 commits into from
Mar 21, 2025
Merged

docs: initial COSI docs website #16

merged 22 commits into from
Mar 21, 2025

Conversation

shanduur
Copy link
Member

@shanduur shanduur commented Feb 7, 2025 •
edited
Loading

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
Copy link
Contributor

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

@k8s-ci-robot 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 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
feat: add pages workflow
cd70ec0 
Signed-off-by: Mateusz Urbanek <[email protected]>
@k8s-ci-robot 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
Copy link
Member Author

shanduur commented Feb 7, 2025

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

@shanduur shanduur changed the title docs: initial boilerplate for COSI docs website docs: initial COSI docs website Feb 7, 2025
anurag4DSB
anurag4DSB reviewed Feb 10, 2025
View reviewed changes
Copy link
Contributor

@anurag4DSB anurag4DSB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@shanduur @anurag4DSB
fix: apply Scality suggestin
a58d3fe 
Co-authored-by: Anurag Mittal <[email protected]>
anurag4DSB
anurag4DSB approved these changes Feb 10, 2025
View reviewed changes
Copy link
Contributor

@anurag4DSB anurag4DSB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes, LGTM :)

datamattsson
datamattsson reviewed Feb 19, 2025
View reviewed changes
@shanduur
docs: added few other sections
f2ba462 
Signed-off-by: Mateusz Urbanek <[email protected]>
@k8s-ci-robot 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
@k8s-ci-robot 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
@k8s-ci-robot 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 k8s-ci-robot requested a review from xing-yang March 10, 2025 13:40
@shanduur
fix: invalid path
028fbd8 
Signed-off-by: Mateusz Urbanek <[email protected]>
BlaineEXE
BlaineEXE reviewed Mar 11, 2025
View reviewed changes
BlaineEXE
BlaineEXE reviewed Mar 11, 2025
View reviewed changes
@shanduur
feat: display version
f9528d2 
Signed-off-by: Mateusz Urbanek <[email protected]>
@shanduur shanduur requested a review from BlaineEXE March 12, 2025 11:11
BlaineEXE
BlaineEXE reviewed Mar 12, 2025
View reviewed changes
BlaineEXE
BlaineEXE reviewed Mar 12, 2025
View reviewed changes
Makefile Outdated
Comment on lines 155 to 178
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is dependabot managing these in the makefile?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

BlaineEXE
BlaineEXE reviewed Mar 12, 2025
View reviewed changes
@shanduur shanduur force-pushed the docs branch 3 times, most recently from c6f07de to 54b19b8 Compare March 12, 2025 16:51
@shanduur
fix: use branch instead of tag
3f3b230 
Signed-off-by: Mateusz Urbanek <[email protected]>
@shanduur shanduur requested a review from BlaineEXE March 20, 2025 15:15
@shanduur
fix: few typos
df4e5fa 
Signed-off-by: Mateusz Urbanek <[email protected]>
BlaineEXE
BlaineEXE approved these changes Mar 21, 2025
View reviewed changes
Copy link
Contributor

@BlaineEXE BlaineEXE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot 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
Copy link
Contributor

[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:

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 k8s-ci-robot merged commit 3cad7ae into kubernetes-sigs:main Mar 21, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datamattsson datamattsson datamattsson left review comments

@anurag4DSB anurag4DSB anurag4DSB approved these changes

@BlaineEXE BlaineEXE BlaineEXE approved these changes

@saad-ali saad-ali Awaiting requested review from saad-ali

@xing-yang xing-yang Awaiting requested review from xing-yang

Assignees

@BlaineEXE BlaineEXE

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@shanduur @k8s-ci-robot @anurag4DSB @BlaineEXE @datamattsson