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

More docs and some restructuring #381

Closed
navidshaikh opened this issue Aug 21, 2019 · 2 comments
Closed

More docs and some restructuring #381

navidshaikh opened this issue Aug 21, 2019 · 2 comments
Assignees
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/doc Issues and pull requests for documentations kind/feature New feature or request kind/proposal Issues or PRs related to proposals.
Milestone

Comments

@navidshaikh
Copy link
Collaborator

In what area(s)?

Classifications:
/kind proposal
/kind doc
/kind cleanup

Describe the feature:

We need to add more docs for flags / features we have now, also some restructuring.

The landing page https://github.com/knative/client#docs links:

  • User guide
  • Generated documentation

User guide links:

  • Workflows (docs/workflows)
  • Operations (docs/operations)
  • Traffic Splitting (docs/traffic)

For Workflows:

  • docs/workflow/README.md <-- landing page linked from user guide docs/README.md
  • docs/workflow/basic.md <-- linked from docs/workflows/README.md
    (can add other workflows )

For Operations:

  • docs/operations/README.md <-- landing page linked from user guide docs/README.md
  • docs/operations/auto_scaling.md <-- linked from docs/operations/README.md
  • docs/operations/labelling.md
  • docs/operations/resources.md
  • docs/operations/all_others.md

For Traffic Splitting:

  • docs/traffic/README.md <-- landing page linked from user guide docs/README.md
    (can have examples created under docs/traffic for e.g. blue/green deployment)
@navidshaikh navidshaikh added kind/feature New feature or request kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/doc Issues and pull requests for documentations kind/proposal Issues or PRs related to proposals. labels Aug 21, 2019
@buildbricks
Copy link
Contributor

/assign joaedwar

@navidshaikh
Copy link
Collaborator Author

Fixed by #421 , the sub-sequent work to fill in docs in operations folder tracked in #424.

coryrc pushed a commit to coryrc/client that referenced this issue May 14, 2020
* Check licenses of all packages, not only `cmd`

* Use check_licenses instead of dep-collector directly
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/doc Issues and pull requests for documentations kind/feature New feature or request kind/proposal Issues or PRs related to proposals.
Projects
None yet
Development

No branches or pull requests

2 participants