Open Ressetkk opened 10 months ago
/area documentation /kind feature
This issue or PR has been automatically marked as stale due to the lack of recent activity. Thank you for your contributions.
This bot triages issues and PRs according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, the issue is closedYou can:
/remove-lifecycle stale
/close
If you think that I work incorrectly, kindly raise an issue with the problem.
/lifecycle stale
This issue or PR has been automatically closed due to the lack of activity. Thank you for your contributions.
This bot triages issues and PRs according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, the issue is closedYou can:
/reopen
/remove-lifecycle stale
If you think that I work incorrectly, kindly raise an issue with the problem.
/close
@kyma-bot: Closing this issue.
This issue has been automatically marked as stale due to the lack of recent activity. It will soon be closed if no further activity occurs. Thank you for your contributions.
This issue has been automatically marked as stale due to the lack of recent activity. It will soon be closed if no further activity occurs. Thank you for your contributions.
Currently documentation is scattered around multiple sources in the repository. We use index.md file and small tool that updates the file accordingly. However it is not ideal (generates quite a number of PRs), as we still need a lot of changes and modifications in the markdown files and there is no easy solution to get all information pretty much easily from organized source.
My proposal is to purpose the docs directory as a centralized source for everything - from design principles to manuals for tools (if applicable).
Proposed tools:
The generated docs will be hosted on GitHub Pages on
https://docs.build.kyma-project.io