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: update README and tidy up docs #619

Merged

Abhinandan-Purkait merged 11 commits into develop from ref-docs

Feb 7, 2025

Member

Abhinandan-Purkait commented Jan 28, 2025 •

edited

Loading

Streamline README to have relevant content.
Tidy up existing docs.
Move deprecated assets to deprecated folder.
Update changelog.
Update RELEASE process.
Remove changelog folder as that becomes a hassle to maintain.

Abhinandan-Purkait requested review from tiagolobocastro, orville-wright, avishnu, niladrih and Alex130469

January 28, 2025 13:11

Abhinandan-Purkait force-pushed the ref-docs branch from 5214ffc to ce57085 Compare

January 28, 2025 13:27

niladrih reviewed

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

changelogs/released/0.8.0-RC1/121-pawanpraka1 Outdated Show resolved Hide resolved

docs/quickstart.md Outdated Show resolved Hide resolved

Abhinandan-Purkait force-pushed the ref-docs branch from ce57085 to 1dcc0d9 Compare

January 29, 2025 05:19

Abhinandan-Purkait requested a review from sinhaashish

January 29, 2025 06:24

Abhinandan-Purkait force-pushed the ref-docs branch from 1dcc0d9 to 79b2923 Compare

January 29, 2025 07:12

This was referenced Jan 29, 2025

[Required] Document overview of project architecture and software design that demonstrates viable cloud native use cases, as part of the project's documentation. This can also be satisfied by completing a General Technical Review and capturing the output in the project's documentation. openebs/community#147

Open

[Required] Document the project's release process. openebs/community#148

Open

avishnu reviewed

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/faq.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/faq.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

avishnu reviewed

View reviewed changes

docs/quickstart.md Outdated Show resolved Hide resolved

tiagolobocastro reviewed

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

docs/quickstart.md Outdated Show resolved Hide resolved

docs/quickstart.md Outdated Show resolved Hide resolved

docs/quickstart.md Show resolved Hide resolved

docs/quickstart.md Outdated Show resolved Hide resolved

docs/quickstart.md Outdated Show resolved Hide resolved

Abhinandan-Purkait force-pushed the ref-docs branch from ea1c848 to 959f9d2 Compare

January 31, 2025 08:10

niladrih reviewed

View reviewed changes

RELEASE.md Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

Abhinandan-Purkait force-pushed the ref-docs branch from 98c1faf to 0e943dc Compare

February 3, 2025 07:28

tiagolobocastro approved these changes

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

avishnu approved these changes

View reviewed changes

Member

avishnu left a comment

Maybe run all the big files once through AI?

Member Author

Abhinandan-Purkait commented Feb 3, 2025

Maybe run all the big files once through AI?

Don't see a substantial change. Its just removing content which it shouldn't.

Abhinandan-Purkait force-pushed the ref-docs branch from 447621a to b6575a4 Compare

February 3, 2025 16:36

Abhinandan-Purkait added 11 commits

February 7, 2025 16:52


          docs: update README and tidy up docs

779d049

Signed-off-by: Abhinandan Purkait <[email protected]>


          chore: update changelog, release and readme

536e6da

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: update README, RELEASE and quickstart

075cb54

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor quickstart and faq

40ab4fc

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor README

69ef3f2

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor README, RELEASE

1f5011e

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor RELEASE

b50ae27

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor README and RELEASE and CONTRIBUTING

91ae0c6

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor CONTRIBUITNG

b244e73

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor CONTRIBUITNG

e5b58b2

Signed-off-by: Abhinandan Purkait <[email protected]>


          docs: refactor RELEASE

b3c40d9

Signed-off-by: Abhinandan Purkait <[email protected]>

Abhinandan-Purkait force-pushed the ref-docs branch from 252bea2 to b3c40d9 Compare

February 7, 2025 11:22

Abhinandan-Purkait merged commit e17e4a0 into develop

6 checks passed

Abhinandan-Purkait deleted the ref-docs branch

February 7, 2025 12:39

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

niladrih niladrih left review comments

tiagolobocastro tiagolobocastro approved these changes

avishnu avishnu approved these changes

orville-wright Awaiting requested review from orville-wright

Alex130469 Awaiting requested review from Alex130469

sinhaashish Awaiting requested review from sinhaashish

Labels

None yet