Sorting the CAPG documentation into a book

[sayantani11]

/kind feature

There are still a few improvements needed in CAPG documentation, but at this moment we can still work on the book. This will be something similar to: https://github.com/kubernetes-sigs/cluster-api-provider-azure/pull/858 It will be better for new contributors or will provide easier usage to the users, apart from this it will also help in better management of docs.

We can have the CAPG docs hosted on Netlify site and request for a new site from the K8s org. We can iterate over the content of the book later, but for now can just set up the site with the existing topics.

Note: Only people with owner rights in a repository can deploy on a Netlify site.

[sayantani11]

Requested in #336 as well /priority important-soon

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten 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 rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten 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 rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/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.

[sayantani11]

/reopen

[k8s-ci-robot]

@sayantani11: Reopened this issue.

In response to this:

/reopen

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.

[sayantani11]

/remove-lifecycle rotten

[sayantani11]

/lifecycle frozen

[richardcase]

/assign salasberryfin

[k8s-ci-robot]

@richardcase: GitHub didn't allow me to assign the following users: salasberryfin.

Note that only kubernetes-sigs members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. For more information please see the contributor guide

In response to this:

/assign salasberryfin

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.

[salasberryfin]

Thanks @richardcase. I'll be working on this.

[richardcase]

/assign salasberryfin

[salasberryfin]

As discussed in this week's community meeting, we'll be working on creating a basic structure of topics for the book and then expanding the contents. We can use other CAPI providers as reference for the must-have topics. Further related issues are expected to emerge as a consequence of this so we can use this one to centralize most of the discussion.

[cpanato]

that sounds awesome! thanks for working on this

[salasberryfin]

The following tasks are required to have the book published:

• [x] Create netlify configuration: https://github.com/kubernetes-sigs/cluster-api-provider-gcp/pull/1131
• [ ] Request site and project subdomain.
  • Netlify site: https://github.com/kubernetes/org/issues/4736
  • Project subdomain:
• [ ] Sort docs into book.

[salasberryfin]

/remove-lifecycle frozen