Skip to content
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

docs: polish and simplify README.md #1183

Merged
merged 1 commit into from
Mar 31, 2023
Merged

docs: polish and simplify README.md #1183

merged 1 commit into from
Mar 31, 2023

Conversation

adamqqqplay
Copy link
Member

  1. Add FAQ, Website and Quickstart link.
  2. Reorganize document structure.
  3. Remove some redundant descriptions.

@adamqqqplay adamqqqplay added the documentation Improvements or additions to documentation label Mar 30, 2023
@adamqqqplay adamqqqplay requested a review from a team as a code owner March 30, 2023 03:22
@anolis-bot
Copy link
Collaborator

@adamqqqplay , a new test job has been submitted. Please wait in patience. The test job url: https://tone.openanolis.cn/ws/nrh4nnio/test_result/63034

@adamqqqplay adamqqqplay mentioned this pull request Mar 30, 2023
Merged
@anolis-bot
Copy link
Collaborator

@adamqqqplay , The CI test is completed, please check result:

Test CaseTest Result
build rust golang image✅ SUCCESS
compile nydusd✅ SUCCESS
compile ctr remote✅ SUCCESS
compile nydus snapshotter✅ SUCCESS
run container with rafs✅ SUCCESS
run container with zran✅ SUCCESS
run container with rafs and compile linux✅ SUCCESS

Congratulations, your test job passed!

imeoer
imeoer reviewed Mar 31, 2023
View reviewed changes
README.md Outdated
## Build Nydus Image

Build Nydus image from directory source: [Nydus Image Builder](./docs/nydus-image.md).
Build Nydus image from directory source: [Buildkit](https://github.com/moby/buildkit/blob/master/docs/nydus.md), [Nydus Image Builder](./docs/nydus-image.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

How about

Convert OCI v1 image to nydus image: Nydusify, Acceld, Nerdctl.
Build nydus image from Dockerfile directly: Buildkit.
Build nydus layer from various sources: Nydus Builder.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

@anolis-bot
Copy link
Collaborator

@adamqqqplay , the code has been updated, so a new test job has been submitted. Please wait in patience. The test job url: https://tone.openanolis.cn/ws/nrh4nnio/test_result/63206

@adamqqqplay
docs: polish and simplify README.md
ba4d2f9 
1. Add FAQ, Website and Quickstart link.
2. Reorganize document structure.
3. Remove some redundant descriptions.

Signed-off-by: Qinqi Qu <quqinqi@linux.alibaba.com>
@anolis-bot
Copy link
Collaborator

@adamqqqplay , the code has been updated, so a new test job has been submitted. Please wait in patience. The test job url: https://tone.openanolis.cn/ws/nrh4nnio/test_result/63207

imeoer
imeoer approved these changes Mar 31, 2023
View reviewed changes
Copy link
Collaborator

@imeoer imeoer left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM.

@imeoer imeoer merged commit a529784 into dragonflyoss:master Mar 31, 2023
@anolis-bot
Copy link
Collaborator

@adamqqqplay , The CI test is completed, please check result:

Test CaseTest Result
build rust golang image✅ SUCCESS
compile nydusd✅ SUCCESS
compile ctr remote✅ SUCCESS
compile nydus snapshotter✅ SUCCESS
run container with rafs✅ SUCCESS
run container with zran✅ SUCCESS
run container with rafs and compile linux✅ SUCCESS

Congratulations, your test job passed!

@anolis-bot
Copy link
Collaborator

@adamqqqplay , The CI test is completed, please check result:

Test CaseTest Result
build rust golang image✅ SUCCESS
compile nydusd✅ SUCCESS
compile ctr remote✅ SUCCESS
compile nydus snapshotter✅ SUCCESS
run container with rafs✅ SUCCESS
run container with zran✅ SUCCESS
run container with rafs and compile linux✅ SUCCESS

Congratulations, your test job passed!

@adamqqqplay adamqqqplay deleted the refine-readme branch March 31, 2023 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@imeoer imeoer imeoer approved these changes

@bergwolf bergwolf Awaiting requested review from bergwolf

@changweige changweige Awaiting requested review from changweige

Assignees
No one assigned
Labels
anolis_test_pass documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@adamqqqplay @anolis-bot @imeoer