Create subfolders for /docs/user
and /docs/contributor
#1712
Labels
area/documentation
Issues or PRs related to documentation
area/quality
Related to all activites around quality
Description
Lifecycle Manager, in general, is not an end-user-facing project. Most of the documents are relevant only to those who contribute to the project; however, some documents are directed to its users.
To have a clear division of the roles we could split the
/docs
folder into/docs/user
and/docs/contributor
.We had a case when the SRE team could not understand why the spec of a Kyma CR was different in the KCP and SKR. These were very technical details that were not explained in the
Kyma CR
documentation as they are not important to the users of Lifecycle Manager. However, the/docs/contributor
folder could be the right location for that kind of information.Also, looking at the folder structure of other
kyma-project
repositories developed by other Kyma teams, especially modules, the split into/docs/user
and /docs/contributor
is the template convention accepted and widely used by most of them.TBD: The open question is how to categorize individual documents and define their final location (user vs. contributor).
Reasons
More transparent project documentation.
Assignees
@kyma-project/technical-writers
@kyma-project/jellyfish
Attachments
The text was updated successfully, but these errors were encountered: