kyma-project / test-infra

Test infrastructure for the Kyma project.
https://status.build.kyma-project.io/
Apache License 2.0
38 stars 181 forks source link

feat: documentation in a centralized source #9136

Open Ressetkk opened 10 months ago

Ressetkk commented 10 months ago

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

Ressetkk commented 10 months ago

/area documentation /kind feature

kyma-bot commented 8 months ago

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:

You can:

If you think that I work incorrectly, kindly raise an issue with the problem.

/lifecycle stale

kyma-bot commented 8 months ago

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:

You can:

If you think that I work incorrectly, kindly raise an issue with the problem.

/close

kyma-bot commented 8 months ago

@kyma-bot: Closing this issue.

In response to [this](https://github.com/kyma-project/test-infra/issues/9136#issuecomment-1868506649): >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](https://github.com/kyma-project/test-infra/issues/new/choose) with the problem. > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
github-actions[bot] commented 6 months ago

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.

github-actions[bot] commented 3 hours ago

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.