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] Configuration examples #102

Merged
merged 28 commits into from
Jan 30, 2025
Merged

[docs] Configuration examples #102

merged 28 commits into from
Jan 30, 2025

Conversation

AleksZimin
Copy link
Member

@AleksZimin AleksZimin commented Oct 26, 2024 •
edited
Loading

Description:

This PR enhances the documentation by adding configuration examples.

Why do we need it, and what problem does it solve?

Adding configuration examples simplifies the onboarding process for users, reduces the likelihood of misconfigurations, and provides clear references for common setups. This improvement enhances the usability of the documentation.

What is the expected result?

  • Users can easily find and apply configuration examples in the documentation.
  • Reduced confusion and errors during the configuration process.

Checklist:

  • The code is covered by unit tests.
  • e2e tests passed.
  • Documentation updated according to the changes.
  • Changes were tested manually.

@AleksZimin AleksZimin self-assigned this Oct 26, 2024
@AleksZimin AleksZimin added bug Something isn't working documentation Improvements or additions to documentation labels Oct 26, 2024
@AleksZimin AleksZimin requested a review from duckhawk October 28, 2024 09:24
duckhawk
duckhawk reviewed Oct 29, 2024
View reviewed changes
docs/LAYOUTS_RU.md Outdated Show resolved Hide resolved
@AleksZimin
add example
5331adb 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
some fixes
93c3cea 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
improve logging
be9f5be 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
add some cases
55cdb3f 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
some logs improvement
2d91721 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
some fixes
26b3764 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
some fixes
006596b 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
update go ver
70ec888 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin AleksZimin force-pushed the configuration-examples branch from 00f688b to 70ec888 Compare November 4, 2024 09:04
@AleksZimin
fix
3a288ce 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
add some docs
d6787b9 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
add set
6b3e615 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
revert all fixes to code
8fcd857 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
fixes after review
118600c 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
add eng translate for faq
64b40d7 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin
add translate for LAYOUTS
a5b881c 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin AleksZimin changed the title Configuration examples [docs] Configuration examples Dec 3, 2024
@AleksZimin AleksZimin marked this pull request as ready for review December 3, 2024 09:01
@AleksZimin AleksZimin requested review from duckhawk and z9r5 December 3, 2024 09:02
@z9r5 z9r5 requested a review from maxinsky December 3, 2024 15:49
@z9r5 z9r5 marked this pull request as draft December 5, 2024 13:56
@z9r5
Copy link
Member

z9r5 commented Dec 5, 2024

Please don't merge the PR. WIP...

denmaloyreb
denmaloyreb reviewed Dec 20, 2024
View reviewed changes
docs/LAYOUTS_RU.md Outdated Show resolved Hide resolved
denmaloyreb
denmaloyreb reviewed Dec 20, 2024
View reviewed changes
docs/LAYOUTS_RU.md Outdated Show resolved Hide resolved
denmaloyreb
denmaloyreb reviewed Dec 25, 2024
View reviewed changes
docs/LAYOUTS_RU.md Outdated Show resolved Hide resolved
z9r5
z9r5 reviewed Jan 16, 2025
View reviewed changes
docs/LAYOUTS_RU.md Outdated Show resolved Hide resolved
z9r5
z9r5 reviewed Jan 16, 2025
View reviewed changes
docs/LAYOUTS_RU.md Outdated Show resolved Hide resolved
denmaloyreb and others added 3 commits January 16, 2025 12:56
@denmaloyreb @z9r5
Update docs/LAYOUTS_RU.md
7359692 
Co-authored-by: Artem Kladov <[email protected]>
Signed-off-by: denmaloyreb <[email protected]>
@denmaloyreb @z9r5
Update docs/LAYOUTS_RU.md
c457a5a 
Co-authored-by: Artem Kladov <[email protected]>
Signed-off-by: denmaloyreb <[email protected]>
[docs] Add info about LVMVolumeGroup (sds-node-configurator)
3d72df4 
Signed-off-by: Denis.Rebenok <[email protected]>
denmaloyreb
denmaloyreb reviewed Jan 17, 2025
View reviewed changes
docs/FAQ_RU.md Outdated Show resolved Hide resolved
z9r5 and others added 6 commits January 17, 2025 12:18
@z9r5 z9r5 marked this pull request as ready for review January 22, 2025 12:46
@AleksZimin
merge main
adb1600 
Signed-off-by: Aleksandr Zimin <[email protected]>
@AleksZimin AleksZimin merged commit b68366d into main Jan 30, 2025
6 of 8 checks passed
@AleksZimin AleksZimin deleted the configuration-examples branch January 30, 2025 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@denmaloyreb denmaloyreb denmaloyreb left review comments

@duckhawk duckhawk duckhawk approved these changes

@z9r5 z9r5 z9r5 approved these changes

@maxinsky maxinsky Awaiting requested review from maxinsky

Assignees

@AleksZimin AleksZimin

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AleksZimin @z9r5 @duckhawk @denmaloyreb @maxinsky