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

docs: Create a new folder structure #1905

Merged
merged 8 commits into from
Oct 1, 2024
Merged

Conversation

mmitoraj
Copy link
Contributor

Description

Changes proposed in this pull request:

  • Create a new folder structure: docs/user vs. docs/contributor
  • Remove obsolete documentation
  • Updated the main README.md
  • Replaced API documentation with CRD documentation

Related issue(s)
#1447
#1712

@mmitoraj mmitoraj requested review from a team as code owners September 30, 2024 14:13
@kyma-bot kyma-bot added cla: yes Indicates the PR's author has signed the CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 30, 2024
@c-pius c-pius linked an issue Oct 1, 2024 that may be closed by this pull request
@c-pius c-pius changed the title Create a new folder structure docs: Create a new folder structure Oct 1, 2024
README.md Outdated Show resolved Hide resolved
docs/contributor/resources/03-moduletemplate.md Outdated Show resolved Hide resolved
docs/contributor/resources/01-kyma.md Outdated Show resolved Hide resolved
docs/contributor/resources/README.md Outdated Show resolved Hide resolved
docs/user/01-10-kyma-crd.md Show resolved Hide resolved
docs/contributor/resources/04-watcher.md Outdated Show resolved Hide resolved
c-pius
c-pius previously approved these changes Oct 1, 2024
@kyma-bot kyma-bot added lgtm Looks good to me! and removed lgtm Looks good to me! labels Oct 1, 2024
@kyma-bot kyma-bot added the lgtm Looks good to me! label Oct 1, 2024
@c-pius c-pius enabled auto-merge (squash) October 1, 2024 14:03
The [Manifest custom resource (CR)](../../../api/v1beta2/manifest_types.go) is our internal representation of what results from the resolution of a ModuleTemplate CR in the context of a single cluster represented by a Kyma CR. Thus, a lot of configuration elements are similar or entirely equivalent to the data layer found in a ModuleTemplate CR.
The `manifests.operator.kyma-project.io` Custom Resource Definition (CRD) defines the structure and format used to configure the Manifest resource.

The Manifest custom resource (CR) represent resources that make up a module and are to be installed by Lifecycle Manager. The Manifest CR is a rendered module added to a particular cluster.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Manifest custom resource (CR) represent resources that make up a module and are to be installed by Lifecycle Manager. The Manifest CR is a rendered module added to a particular cluster.
The Manifest custom resource (CR) represents resources that make up a module and are to be installed by Lifecycle Manager. The Manifest CR is a rendered module added to a particular cluster.

@c-pius c-pius merged commit 0031395 into kyma-project:main Oct 1, 2024
34 checks passed
@mmitoraj mmitoraj deleted the user-contr branch October 1, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Indicates the PR's author has signed the CLA. lgtm Looks good to me! size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create subfolders for /docs/user and /docs/contributor
4 participants