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

Update the "Install" section to cover "Install options" #1898

Closed
1 of 8 tasks
RichieEscarez opened this issue Oct 12, 2019 · 4 comments
Closed
1 of 8 tasks

Update the "Install" section to cover "Install options" #1898

RichieEscarez opened this issue Oct 12, 2019 · 4 comments
Labels
kind/eventing kind/install kind/serving lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/high
Milestone

Comments

@RichieEscarez
Copy link
Contributor

RichieEscarez commented Oct 12, 2019

The install details for either the Serving or Eventing component are to be separated into their individual sections. This provides users the specific details about only the Knative component they are interested.

With the above model, the top-level "Install" section should be repurposed to provide an overview, the available install options, and enough detail to help the user choose the desired install path.

The following changes need to be made:

  • For all moved or renamed files, add a redirect to that file's frontmatter (Ensure that all content affected by the nav changes gets a "redirect" #1925)
  • Rename section to "Install options"
  • Direct users to the Serving or Eventing specific instructions
    - Mention that those instructions require a pre-existing cluster ("component specific instructions that you can use to install Knative on any Kubernetes cluster")
    - "If you want to install xyz, then see the instructions at...."
  • Edit:
    Clearly state the available install options:
    - Ensure both components are equally discussed (currently only mentions serving)
    - (1) See Serving (includes installing 'kn')
    - (2) See Eventing (includes installing 'kn')
    - (3) Or See one of the following guide if you want to install locally or on one of the following hosts (community contributed host specific guides)
    Mention and link to:
    - 'kn' CLI (install and use it to.......)
    - "Cluster maintenance" section (if you want to modify your installation or upgrade, see ....)
  • Create a sub-section "Installing locally or on hosted clusters"
    • Move the "local" and "hosted" install guides here
    • Explain/mention that they "help you quickly install both Serving and Eventing in the specified environment or hosted cluster"
  • Move/repurpose the "install on existing cluster" into separate Serving and Eventing specific instructions
@samodell
Copy link
Contributor

Newer plan: #2137

If we move forward with the plan outlined there, I'll close this out.

@knative-housekeeping-robot

Issues go stale after 90 days of inactivity.
Mark the issue as fresh by adding the comment /remove-lifecycle stale.
Stale issues rot after an additional 30 days of inactivity and eventually close.
If this issue is safe to close now please do so by adding the comment /close.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/lifecycle stale

@knative-prow-robot knative-prow-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 27, 2020
@RichieEscarez RichieEscarez removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 27, 2020
@RichieEscarez
Copy link
Contributor Author

Reopening for now but we need revisit this since it doesn't look like all of these were addressed in #2137

@RichieEscarez RichieEscarez reopened this Aug 20, 2020
@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 Nov 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/eventing kind/install kind/serving lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/high
Projects
None yet
Development

No branches or pull requests

5 participants