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.

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

[Mandatory Modules] - Documentation #1053

Closed
3 tasks done
lindnerby opened this issue Nov 16, 2023 · 0 comments · Fixed by kyma-project/cli#1904 or #1231
Closed
3 tasks done

[Mandatory Modules] - Documentation #1053

lindnerby opened this issue Nov 16, 2023 · 0 comments · Fixed by kyma-project/cli#1904 or #1231
Assignees
Labels
area/documentation Issues or PRs related to documentation

Comments

@lindnerby
Copy link
Member

lindnerby commented Nov 16, 2023

Description

To help with troubleshooting when introducing the feature of Mandatory Modules, we should consider supplying explanatory documentation on how the feature works and is used.

Reasons

No response

Acceptance Criteria

  • Documentation for the alpha create module command updated in the CLI
  • Feature documentation
    • Description of the way Mandatory Modules work and what is the behaviour of the KLM regarding those
    • Think about creating a visualisation of this feature to point out the difference of it or enhance existing diagram
    • Kyma Status and channel in regards to the Mandatory Modules
      • Status does not get influenced by them
      • Channel concept does not apply
  • Update the table of module-config.yaml with the new mandatory spec

Feature Testing

No response

Testing approach

No response

Attachments

No response

@lindnerby lindnerby added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 16, 2023
@lindnerby lindnerby changed the title [Mandatory Modules] - Troubleshooting Documentation [Mandatory Modules] - Documentation Nov 16, 2023
@janmedrek janmedrek added area/documentation Issues or PRs related to documentation and removed kind/feature Categorizes issue or PR as related to a new feature. labels Dec 15, 2023
@nesmabadr nesmabadr self-assigned this Jan 10, 2024
@nesmabadr nesmabadr reopened this Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation
Projects
None yet
4 participants