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

Update RMK documentation for the CAPI-based release v0.45+ #59

Open
1 task done
anovikov-el opened this issue Jan 14, 2025 · 0 comments · May be fixed by #62
Open
1 task done

Update RMK documentation for the CAPI-based release v0.45+ #59

anovikov-el opened this issue Jan 14, 2025 · 0 comments · May be fixed by #62
Assignees
@anovikov-el @apanasiuk-el
Labels
documentation Improvements or additions to documentation
Milestone
RMK v0.45.X

Comments

@anovikov-el
Copy link
Contributor

anovikov-el commented Jan 14, 2025 •
edited
Loading

Description

The following documentation sections should be updated:

  • rmk config init
  • rmk project generate
  • rmk cluster сapi

Additional things to mention:

  • authentication credentials setup per each cluster provider
  • secrets manager logic per each cluster provider

Agree to the Code of Conduct

  • I agree to follow this project's Code of Conduct
@anovikov-el anovikov-el added the documentation Improvements or additions to documentation label Jan 14, 2025
@anovikov-el anovikov-el modified the milestones: RMK, RMK v0.45.X Jan 21, 2025
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update main README.md file.
d1ae29e
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update main README.md file.
1a964c8
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update main README.md file.
f9cb291
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update main README.md file.
eec0961
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update main README.md file.
237b873
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update main index.md file according to README.md.
1437e79
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update main index.md file according to README.md.
26ec195
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update index.md file's Roadmap, Supported Kubernetes cluster pr…
df99af6 
…oviders.
anovikov-el added a commit that referenced this issue Jan 22, 2025
@anovikov-el
#59 - Update index.md file's Roadmap, Supported Kubernetes cluster pr…
a6dc5cf 
…oviders.
anovikov-el added a commit that referenced this issue Jan 23, 2025
@anovikov-el
#59 - Update rest of .md files, leave TODOs.
9c11b44
@anovikov-el anovikov-el linked a pull request Jan 23, 2025 that will close this issue
Feature/rmk 59 update rmk documentation for the capi based release v045 #62
Draft
anovikov-el added a commit that referenced this issue Jan 23, 2025
@anovikov-el
#59 - Add Status and Backward compatibility sections.
d9925ac
anovikov-el added a commit that referenced this issue Jan 23, 2025
@anovikov-el
#59 - Add Backward compatibility sections to the top navigation.
2c801ea
anovikov-el added a commit that referenced this issue Jan 23, 2025
@anovikov-el
#59 - Add Backward compatibility sections to the top navigation.
6b6ae78
anovikov-el added a commit that referenced this issue Jan 23, 2025
@anovikov-el
#59 - Rename kodjin scope to rmk-test.
186089e
anovikov-el added a commit that referenced this issue Jan 25, 2025
@anovikov-el
#59 - Update exported-environment-variables.md. Change AWS account ID…
b7dd2e4 
… to a dummy value.
anovikov-el added a commit that referenced this issue Jan 25, 2025
@anovikov-el
#59 - Update exported-environment-variables.md.
fa5ecad
anovikov-el added a commit that referenced this issue Jan 25, 2025
@anovikov-el
#59 - Update secrets-management.md.
114af5c
anovikov-el added a commit that referenced this issue Jan 25, 2025
@anovikov-el
#59 - Update secrets-management.md.
d826029
anovikov-el added a commit that referenced this issue Jan 27, 2025
@anovikov-el
#59 - Update secrets-management.md.
56702a2
anovikov-el added a commit that referenced this issue Jan 27, 2025
@anovikov-el
#59 - Update secrets-management.md.
32e2965
anovikov-el added a commit that referenced this issue Jan 27, 2025
@anovikov-el
#59 - Update secrets-management.md.
4a4e4dd
anovikov-el added a commit that referenced this issue Jan 27, 2025
@anovikov-el
#59 - Update secrets-management.md.
29c2cf6
anovikov-el added a commit that referenced this issue Jan 28, 2025
@anovikov-el
#59 - Fix links in index.md.
fe38f23
anovikov-el added a commit that referenced this issue Jan 29, 2025
@anovikov-el
#59 - Add all example outputs to quickstart.md
063dfde
apanasiuk-el added a commit that referenced this issue Jan 30, 2025
@apanasiuk-el
#59 - resolve conflict
64e9c12
apanasiuk-el added a commit that referenced this issue Jan 30, 2025
@apanasiuk-el
#59 - add backward compatibility
e14ca5a
anovikov-el added a commit that referenced this issue Jan 30, 2025
@anovikov-el
#59 - Fix quickstart.md. Bump current year in copyright in mkdocs.yml
1d2b33e
anovikov-el added a commit that referenced this issue Jan 30, 2025
@anovikov-el
#59 - Update preparation-of-project-repository.md.
757ffba
anovikov-el added a commit that referenced this issue Jan 30, 2025
@anovikov-el
#59 - Update index.md.
86ef438
anovikov-el added a commit that referenced this issue Jan 30, 2025
@anovikov-el
#59 - Improve project generation section in preparation-of-project-re…
0cfd770 
…pository.md.
apanasiuk-el added a commit that referenced this issue Jan 31, 2025
@apanasiuk-el
#59 - refactoring backward compatibility
4732c55
apanasiuk-el added a commit that referenced this issue Jan 31, 2025
@apanasiuk-el
#59 - refactoring backward compatibility
0bd14c3
apanasiuk-el added a commit that referenced this issue Jan 31, 2025
@apanasiuk-el
#59 - refactoring backward compatibility
586f20b
anovikov-el added a commit that referenced this issue Feb 3, 2025
@anovikov-el
#59 - Improve release-management.md.
a7805e0
anovikov-el added a commit that referenced this issue Feb 3, 2025
@anovikov-el
#59 - Improve release-management.md, secrets-management.md.
c3987c4
apanasiuk-el added a commit that referenced this issue Feb 3, 2025
@apanasiuk-el
#59 - refactoring cluster-management
b135c72
anovikov-el added a commit that referenced this issue Feb 5, 2025
@anovikov-el
#59 - Refactor backward-compatibility.md.
3b7b072
anovikov-el added a commit that referenced this issue Feb 5, 2025
@anovikov-el
#59 - Fix formating in cluster-management.md, index.md, README.md, se…
1202e9e 
…crets-management.md.
anovikov-el added a commit that referenced this issue Feb 5, 2025
@anovikov-el
#59 - Sync README.md with index.md.
2d2c4e2
anovikov-el added a commit that referenced this issue Feb 5, 2025
@anovikov-el
#59 - Sync README.md with index.md.
a026c67
anovikov-el added a commit that referenced this issue Feb 5, 2025
@anovikov-el
#59 - Remove short arguments in the documentation in favour of using …
e5458e2 
…the full versions.
anovikov-el added a commit that referenced this issue Feb 5, 2025
@anovikov-el
#59 - Fix domain examples, cross-doc links.
a99cdaf
anovikov-el added a commit that referenced this issue Feb 5, 2025
@anovikov-el
#59 - Standardize project/tenant names.
dc6eb93
anovikov-el added a commit that referenced this issue Feb 6, 2025
@anovikov-el
#59 - Refactor cluster-management.md
51b8f6b
anovikov-el added a commit that referenced this issue Feb 6, 2025
@anovikov-el
#59 - Refactor cluster-management.md
d018a9a
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Add overview section at the beginning of the pages.
0d7400d
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Reformat code using IDEA in all .md files.
3b6c6ec
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Refactor configuration-management.md and. Reformat cluster-mana…
c38a29a 
…gement.md.
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Refactor and reformat all init-*-provider.md files.
07d8f7f
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Refactor and reformat all init-*-provider.md files.
8c258bf
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Refactor advantages in index.md and README.md.
f807280
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Refactor preparation-of-project-repository.md and requirement-f…
aab484d 
…or-project-repository.md.
anovikov-el added a commit that referenced this issue Feb 7, 2025
@anovikov-el
#59 - Refactor cluster-management.md.
b480195
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@anovikov-el anovikov-el

@apanasiuk-el apanasiuk-el

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
RMK v0.45.X
Development

Successfully merging a pull request may close this issue.

Feature/rmk 59 update rmk documentation for the capi based release v045 edenlabllc/rmk
2 participants
@anovikov-el @apanasiuk-el