Skip to content

Commit

Permalink
📝 Update docs (#411)
Browse files Browse the repository at this point in the history
  • Loading branch information
tosone authored Nov 17, 2024
1 parent e68acae commit 50c42c5
Show file tree
Hide file tree
Showing 4 changed files with 2,873 additions and 4,304 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/go-sigma/sigma/test.yml?style=for-the-badge) ![Codecov](https://img.shields.io/codecov/c/github/go-sigma/sigma?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/go-sigma/sigma?style=for-the-badge)

> We are heavily developing on the dev branch, and the next version will have a lot of changes..
> We are heavily developing on the dev branch, and the next version will have a lot of changes.
Sigma is an image registry that is extremely easy to deploy and maintain, and it adheres to the interface standards defined by the [OCI Distribution Specification 1.1](https://github.com/opencontainers/distribution-spec/tree/v1.1.0), it can also support any other client programs that follow the interface definition of the OCI Distribution Specification, such as [oras](https://github.com/oras-project/oras), [apptainer](https://github.com/apptainer/apptainer), [helm](https://github.com/helm/helm), and [nerdctl](https://github.com/containerd/nerdctl).

Expand Down
3 changes: 3 additions & 0 deletions docs/blog/2023-12-26-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ title: Sigma is coming! Harbor is outdating?
authors: [tosone]
---


In the era of cloud-native, where the majority of software artifacts have transitioned from the software itself to OCI-Native images, the OCI-Native image registry has become an indispensable component in most DevOps systems. This shift has reduced the complexity of artifact delivery and allowed for better management of artifacts and their versions from a role-based permission perspective. Moreover, it emphasizes the security of artifact delivery and sets requirements for the speed of container deployment in relation to the image registry.

<!-- truncate -->

## Why develop sigma?

The initial idea behind developing Sigma was to reduce the complexity of deploying Harbor components while maintaining their architectural advantages in terms of high availability. Sigma aims to excel in four aspects: artifact metadata management, permission management, artifact distribution, and ease of deployment and maintenance. These aspects were taken into consideration from the very beginning during the design of Sigma.
Expand Down
16 changes: 8 additions & 8 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@
"typecheck": "tsc"
},
"dependencies": {
"@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@mdx-js/react": "^3.0.1",
"@docusaurus/core": "^3.6.1",
"@docusaurus/preset-classic": "^3.6.1",
"@mdx-js/react": "^3.1.0",
"docusaurus-plugin-sass": "^0.2.5",
"prism-react-renderer": "^2.4.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"sass": "^1.78.0",
"sass": "^1.81.0",
"typed.js": "^2.1.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/tsconfig": "^3.5.2",
"@docusaurus/module-type-aliases": "^3.6.1",
"@docusaurus/tsconfig": "^3.6.1",
"@tsconfig/docusaurus": "^2.0.3",
"typescript": "^5.6.2"
"typescript": "^5.6.3"
},
"browserslist": {
"production": [
Expand All @@ -46,5 +46,5 @@
"engines": {
"node": ">=16.14"
},
"packageManager": "yarn@4.1.1"
"packageManager": "yarn@4.5.1"
}
Loading

0 comments on commit 50c42c5

Please sign in to comment.