Skip to content

Commit

Permalink
Update README to explain future documentation plans
Browse files Browse the repository at this point in the history
  • Loading branch information
yunkon-kim committed Nov 8, 2023
1 parent 79ed777 commit 510c53f
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 34 deletions.
36 changes: 13 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
# Cloud-Barista development documentation
Cloud-Barista was created for the purpose of overcoming the limitations of using a single cloud and developing core technologies that provide essential common functions required for operation and management of multi-cloud services that have emerged as a recent trend.
# Cloud-Barista materials

It is a cloud-based technology to configure a multi-cloud computing infrastructure by connecting various heterogeneous cloud infrastructures around the world, and to deploy, manage, and provide various application services anywhere in the world based on the multi-cloud infrastructure.
**Cloud-Barista Community actively contributes to multi-cloud technology advancement**, and we share documentation outputs throughout the development process, fostering a collaborative ecosystem for continuous innovation in multi-cloud technology.

Cloud-Barista Community shares output documentations during Cloud-Barista development.
**Cloud-Barista's core frameworks have been providing essential common functions required for the operation and management of multi-cloud services.** Leveraging the combined strengths of the integrated multi-cloud infrastructure, it makes you facilitate the deployment, management, and delivery of various application services on a global scale. We promise that we will continue to improve our core frameworks.

<br>
**Cloud-Barista seeks to further expand its cloud migration technology** based on the core frameworks that have been steadily developed so far. We will take an in-depth look at all of the various IT assets (i.e. infrastructure, software, and data) and provide technology to migrate them in an integrated manner. We hope this technology will help you bring your IT assets to the cloud and accelerate your successful SaaS transformation.

Related materials are as follows.

## Cloud-Barista development contribution guide
- [We're looking for contributions(English)](https://github.com/cloud-barista/docs/blob/master/CONTRIBUTING.md "docs/CONTRIBUTING.md")

- [Contribution Guide](https://github.com/cloud-barista/docs/blob/master/contributing/how_to_open_a_pull_request-ko.md "docs/contributing/how_to_open_a_pull_request-ko.md")

- [Contributor Covenant Code of Conduct(English)](https://github.com/cloud-barista/docs/blob/master/contributing/CODE_OF_CONDUCT.md "docs/contributing/CODE_OF_CONDUCT.md")
- [Contributor Covenant Code of Conduct(English)](https://github.com/cloud-barista/docs/blob/master/CODE_OF_CONDUCT.md "docs/CODE_OF_CONDUCT.md")

<br>
## Cloud-Barista Community Open Conference materials

## Cloud-Barista Community Open Conference materials (Presentation files and Movie clips)
You can find presentation files and video clips.

- [1st Open Conference (v0.1.0-americano)](https://github.com/cloud-barista/docs/tree/master/openseminar/v0.1.0-americano "docs/openseminar/v0.1.0-americano")

Expand All @@ -36,27 +37,16 @@ Cloud-Barista Community shares output documentations during Cloud-Barista develo

## Other event presentation materials (PPT files)

You can find presentation files.

- [Other event presentations](https://github.com/cloud-barista/docs/tree/master/presentations "docs/presentations")


<br>

## Technical documents

- ### Requirements
- [Requirement Definition](https://github.com/cloud-barista/docs/tree/master/technical_docs/requirements "docs/technical_docs/requirements")

- ### Design documents
- [Cloud-Barista System design and gRPC design](https://github.com/cloud-barista/docs/tree/master/technical_docs/design "docs/technical_docs/design")

- ### Definition of User functions

- [User Services and Features Overview](https://github.com/cloud-barista/docs/blob/master/technical_docs/features/CB-User_Functions.md "docs/technical_docs/features/CB-User_Functions.md")

- ### API documents
- [Cloud-Barista User functions](https://github.com/cloud-barista/docs/blob/master/technical_docs/features/CB-User_Functions.md "technical_docs/features/CB-User_Functions.md")

- [Cloud-Barista User REST APIs](https://github.com/cloud-barista/docs/blob/master/technical_docs/API/CB-User_REST-API.md "docs/technical_docs/API/CB-User_REST-API.md")
You can find documents of requirements, design, user functions, and APIs.

- [Update guide for gRPC User APIs](https://github.com/cloud-barista/docs/blob/master/technical_docs/API/CB-User_gRPC-Go-API-update_guide.md "docs/technical_docs/API/CB-User_gRPC-Go-API-update_guide.md")
- [Technical documents](https://github.com/cloud-barista/docs/tree/master/technical_docs "docs/technical_docs")

7 changes: 7 additions & 0 deletions technical_docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Technical documents

Since 2019, Cloud-Barista Community has been researching and developing multi-cloud common platform technology, and has consistently shared related technical documents.

From now on, we plan to expand to cloud migration technology based on multi-cloud common platform technology. Therefore, we would like to share documents related to cloud migration technology that have been inherited and expanded from the existing documents. See [cloud-migrator](https://github.com/cloud-barista/docs/tree/master/technical_docs/cloud-migrator "docs/technical_docs/cloud-migrator") directory.

Note - We will freeze the existing technical documents as is. See [cloud-barista](https://github.com/cloud-barista/docs/tree/master/technical_docs/cloud-barista "docs/technical_docs/cloud-barista") directory
11 changes: 0 additions & 11 deletions technical_docs/cloud-migrator/requirements/README.md

This file was deleted.

0 comments on commit 510c53f

Please sign in to comment.