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

[che-operator] Make REAMDE.md files up to date #18295

Closed
flacatus opened this issue Nov 5, 2020 · 3 comments
Closed

[che-operator] Make REAMDE.md files up to date #18295

flacatus opened this issue Nov 5, 2020 · 3 comments
Assignees
@AndrienkoAleksandr @flacatus
Labels
area/che-operator Issues and PRs related to Eclipse Che Kubernetes Operator kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Milestone
7.23

Comments

@flacatus
Copy link
Contributor

flacatus commented Nov 5, 2020 •
edited
Loading

Is your task related to a problem? Please describe.

Right now we have a good bank of tests in che-operator and chectl which are not documented anywhere.

Describe the solution you'd like

Create a Readme.md to describe:

  • What part of project we are covering in tests
  • In which platforms we are running our tests(Also which CI we are using...)
  • Describe for external contribuitors how our tests are working(how to trigger, where to see the test results etc)

Describe alternatives you've considered

Additional context
@flacatus flacatus added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Nov 5, 2020
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Nov 5, 2020
@tolusha tolusha added area/che-operator Issues and PRs related to Eclipse Che Kubernetes Operator severity/P2 Has a minor but important impact to the usage or development of the system. area/chectl Issues related to chectl, the CLI of Che and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Nov 5, 2020
@tolusha
Copy link
Contributor

tolusha commented Nov 6, 2020

I also would like to extend the issue by updating README.md file in operator repository.
Some sections are required to be reviewed.
Also it is need to add section to mention

  • how to update CRD propertly
  • how to add new roles
  • in which cases olm/update-nightly-bundle.sh is needed to run
    ..etc ?
    @mmorhun @AndrienkoAleksandr

@tolusha tolusha changed the title Document chectl and che operator tests [chectl] [che-operator] Make REAMDE.md files up to date Nov 6, 2020
@AndrienkoAleksandr
Copy link
Contributor

We should fix info about how to debug che-operator, info is outdated. And we can apply info about our VSCode tasks for development.

@tolusha tolusha added this to the 7.23 milestone Nov 9, 2020
@tolusha
Copy link
Contributor

tolusha commented Nov 10, 2020

Added some chectl usage cases, like how to deploy:

  • in single-user mode
  • in single-host mode
  • without generating untrusted ssl certificate
    etc...

@tolusha tolusha mentioned this issue Nov 16, 2020
Closed
58 tasks
@AndrienkoAleksandr AndrienkoAleksandr mentioned this issue Nov 24, 2020
Merged
@tolusha tolusha changed the title [chectl] [che-operator] Make REAMDE.md files up to date [che-operator] Make REAMDE.md files up to date Nov 30, 2020
@tolusha tolusha removed the area/chectl Issues related to chectl, the CLI of Che label Nov 30, 2020
@tolusha tolusha closed this as completed Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AndrienkoAleksandr AndrienkoAleksandr

@flacatus flacatus

Labels
area/che-operator Issues and PRs related to Eclipse Che Kubernetes Operator kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Projects
None yet
Milestone
7.23
Development

No branches or pull requests
4 participants
@tolusha @AndrienkoAleksandr @che-bot @flacatus