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

Fill in docs for TODOs in docs/operations #424

Closed
navidshaikh opened this issue Oct 1, 2019 · 13 comments
Closed

Fill in docs for TODOs in docs/operations #424

navidshaikh opened this issue Oct 1, 2019 · 13 comments
Labels
good first issue Denotes an issue ready for a new contributor. kind/documentation kind/feature New feature or request lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@navidshaikh
Copy link
Collaborator

In what area(s)?

Classifications:
/kind good-first-issue
/kind doc

Describe the feature:

Followup of #381
We'll need docs for

  1. docs/operations/others.md
  2. docs/operations/labeling.md
  3. docs/operations/resources.md

which are currently marked as TODO.

@navidshaikh navidshaikh added the kind/feature New feature or request label Oct 1, 2019
@knative-prow-robot knative-prow-robot added good first issue Denotes an issue ready for a new contributor. kind/doc Issues and pull requests for documentations labels Oct 1, 2019
@itsmurugappan
Copy link
Contributor

I can help with this.

@navidshaikh
Copy link
Collaborator Author

@itsmurugappan : Thanks for the response! The docs work is being tracked more actively in #510. There are more references in the mentioned issue about how we'd like to have docs structured. PTAL.

@itsmurugappan
Copy link
Contributor

@navidshaikh thanks. Looks like there is a team already working on it. looking for a good first issue .

@wslyln
Copy link
Contributor

wslyln commented Feb 6, 2020

Hi just double checking is anyone working on this issue? or on the other issue #510?

@rhuss
Copy link
Contributor

rhuss commented Feb 7, 2020

I'm currently on the top-level client README and cleaning up some other parts, but otherwise, most of the other documentation ideas mentioned in #510 are probably to implementation on the main documentation site. We are still late though ;-( // @abrennan89

Anything you are interested in particular? If so, i can break down the task in more concrete working items.

@wslyln
Copy link
Contributor

wslyln commented Feb 7, 2020

@rhuss Any of them would be fine. Though yes breaking down into more concrete items would be helpful :)

@rhuss
Copy link
Contributor

rhuss commented Feb 8, 2020

@wslyln thanks ! Going to work on breaking down doc items on monday. Stay tuned ;-) ....

@rhuss
Copy link
Contributor

rhuss commented Feb 11, 2020

I think we should remove that whole "operations" section and make it part of the #650 User Manual, which eventually should be hosted on knative.dev (to avoid duplication).

Also, the other sectiosn of this user documentation should be absorbed by the user manual.

@rhuss
Copy link
Contributor

rhuss commented Sep 14, 2020

Lets keep the issue open (and dont move it over to the docs repo) as this is about cleaning up documentation within this repo.

However, I still believe that having that kind of information as part of the user manual (#650) makes a lot of sense.

@rhuss rhuss added kind/documentation and removed kind/doc Issues and pull requests for documentations labels Sep 14, 2020
@NEERAJAP2001
Copy link

@rhuss sir, how can I go ahead with solving the issue as docs are already there?

@github-actions
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 14, 2020
@navidshaikh
Copy link
Collaborator Author

/close
in favor of other docs rehaul issue

@knative-prow-robot
Copy link
Contributor

@navidshaikh: Closing this issue.

In response to this:

/close
in favor of other docs rehaul issue

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
good first issue Denotes an issue ready for a new contributor. kind/documentation kind/feature New feature or request lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

6 participants