Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Refactor #7636

Closed
2 of 6 tasks
mikesplain opened this issue Sep 20, 2019 · 11 comments
Closed
2 of 6 tasks

Docs Refactor #7636

mikesplain opened this issue Sep 20, 2019 · 11 comments
Assignees
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@mikesplain
Copy link
Contributor

mikesplain commented Sep 20, 2019

We've had a number of attempts to refactor our docs into a docs site over the past few years and I'm hoping we can finally get this done soon. This issue will represent the core refactor, started in #5085.

The major refactor and movement is currently taking place in #7593

Outstanding issues I would like to address once that merges:

  • [] Getting an actual site live on github pages
  • Getting the site live on netlify: https://kops.sigs.k8s.io/
  • Reduce spread and duplication of docs
    • There are quite a few docs that are similar and spread out, many were also not include in the mkdocs site yet out of sheer quantity. In order to keep Docs cleanup / mkdocs migration #7593 manageable I decided not to be too aggressive on the cleanup. I think smaller PRs will help us solve this as we go.
    • Feel free to propose changes in the form of PRs and assign them to me, ideas always welcome!
  • Breaking down the kops README.md to be smaller with links to subpages in docs.
  • Convert docs/index.md and docs/README.md to sym link of README.md.
  • Maybe eventually turn strict checking back on, disabling strict check in mkdocs allows docs to exist in the docs folder without being on the github site while we figure out where to organize them.
  • Update video and architecture diagrams
@mikesplain
Copy link
Contributor Author

Based on kubernetes/community#3454, we can request a netlify site setup and work with Sig-docs to setup. This is likely the best bet for us!

@mrbobbytables
Copy link
Member

/assign

@mrbobbytables
Copy link
Member

/unassign

woops, meant to assign the k/org issue...too many tabs open

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 19, 2020
@mikesplain mikesplain removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 19, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 19, 2020
@mikesplain mikesplain removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 19, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 16, 2020
@mikesplain
Copy link
Contributor Author

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 17, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 16, 2020
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jan 15, 2021
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

@k8s-ci-robot
Copy link
Contributor

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
None yet
Development

No branches or pull requests

4 participants