test-infra
test-infra copied to clipboard
feat: documentation in a centralized source
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:
- https://gohugo.io - with one of free documentation themes https://themes.gohugo.io/tags/docs/ super small and lightweight static site generator - natively built in golang
- https://github.com/docsifyjs/docsify - with support provided by @kyma-project/technical-writers Complex solution that requires full nodejs present during build process, but adopted by internal teams
The generated docs will be hosted on GitHub Pages on https://docs.build.kyma-project.io
/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:
- After 60d of inactivity,
lifecycle/stale
is applied - After 7d of inactivity since
lifecycle/stale
was applied, the issue is closed
You can:
- Mark this issue or PR as fresh with
/remove-lifecycle stale
- Close this issue or PR with
/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:
- After 60d of inactivity,
lifecycle/stale
is applied - After 7d of inactivity since
lifecycle/stale
was applied, the issue is closed
You can:
- Reopen this issue or PR with
/reopen
- Mark this issue or PR as fresh with
/remove-lifecycle stale
If you think that I work incorrectly, kindly raise an issue with the problem.
/close
@kyma-bot: Closing this issue.
In response to this:
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:
- After 60d of inactivity,
lifecycle/stale
is applied- After 7d of inactivity since
lifecycle/stale
was applied, the issue is closedYou can:
- Reopen this issue or PR with
/reopen
- Mark this issue or PR as fresh with
/remove-lifecycle stale
If you think that I work incorrectly, kindly raise an issue with the problem.
/close
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
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.
This issue has been automatically closed due to the lack of recent activity. /lifecycle rotten