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

Move wiki documents under @docs/` and update them #4008

Closed
7 tasks done
shu-mutou opened this issue Jul 3, 2019 · 16 comments
Closed
7 tasks done

Move wiki documents under @docs/` and update them #4008

shu-mutou opened this issue Jul 3, 2019 · 16 comments
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@shu-mutou
Copy link
Contributor

shu-mutou commented Jul 3, 2019

Reasons
  1. Due to instruction by k8s org, only maintainer can edit wiki pages since this year.
  2. Therefore, contributor can not propose documentation updates by PR.
  3. Wiki contents are out of dates. Partially fairly.
  4. Before release 2.0.0, we need to update docs.
TODOs
  • for 2.0.0 or later
    • Reorganize docs/, create indexes and blank pages. Reorganize docs/ #4009
    • Fill blank pages with new descriptions or add new pages if needed. (divided work)
  • for 1.10.1 or before
    After migration to docs/, revert wiki for <=1.10.1.
    • Revert wiki revision to 1.10.1 (to the end of last year). (maintainer only)
    • Add notice for <=1.10.1 on wiki pages. (maintainer only)
    • Add link to docs/ for >=2.0.0" on wiki pages. (maintainer only)
    • Let's consider migration of docs for <=1.10.1 later.
      Old documents are all removed.
@shu-mutou shu-mutou added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Jul 3, 2019
@shu-mutou
Copy link
Contributor Author

shu-mutou commented Jul 3, 2019

Please raise your hand to the part that you can help and submit PR.
Wiki pages to be migrated and assignee (needed merging #4009):

@maciaszczykm maciaszczykm added kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Jul 3, 2019
@maciaszczykm
Copy link
Member

maciaszczykm commented Jul 4, 2019

Once the docs are moved we should also update docs button on About page in the app.

Done in #4052.

@maciaszczykm
Copy link
Member

We should close the Wikis once this will be done.

@maciaszczykm
Copy link
Member

Arch image should be updated to replace Heapster.

@maciaszczykm
Copy link
Member

maciaszczykm commented Jul 18, 2019

Please also add #3504 (comment) info to the docs. Can be placed in FAQ or some dev doc.

Notice that YAML location changed and add also URL to enter the app.

@maciaszczykm
Copy link
Member

@jeefy Would be nice if you would describe dev process with the metrics. Some manual, tips etc.

@maciaszczykm
Copy link
Member

export GO111MODULE=on should be part of the docs too.

@jeefy
Copy link
Member

jeefy commented Jul 23, 2019

/assign

@shu-mutou
Copy link
Contributor Author

export GO111MODULE=on should be part of the docs too.

it would be done in #4169.

@shu-mutou
Copy link
Contributor Author

export GO111MODULE=on should be part of the docs too.

Done in #4169

@shu-mutou
Copy link
Contributor Author

@maciaszczykm @jeefy I'm unlikely to be able to update FAQ, Roadmap and Integrations well. Could you guys update them?

@maciaszczykm
Copy link
Member

For FAQ, it's worth to mention that kubectl -n kubernetes-dashboard port-forward svc/dashboard-metrics-scraper 8000:8000 allows to test metrics locally.

@shu-mutou
Copy link
Contributor Author

shu-mutou commented Sep 6, 2019

For FAQ, it's worth to describe increasing kernel setting fs.inotify.max_user_watches on host when developer faces Error: ENOSPC: System limit for number of file watchers reached, watch in npm start.

To increase the parameter, run echo fs.inotify.max_user_watches=582222 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p.

@nathansmyth
Copy link

These updates are creating broken links support sites, including the issues in this project.

Is there a way to redirect from the wiki to the new address?

For example, going to https://github.com/kubernetes/dashboard/wiki/Creating-sample-user now redirects to the wiki home page. And from what I'm reading in this issue, soon all documentation links will do the same.

Here are two examples of where this issue is occuring:
Azure/aks-engine#805
#2787

@maciaszczykm
Copy link
Member

Also #4121 should be covered by this issue.

@shu-mutou
Copy link
Contributor Author

Wiki contents that should be migrated to /docs have fully migrated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Development

No branches or pull requests

4 participants