Skip to content

Separate technical documentation from the project page #6302

@dwelsch-esi

Description

@dwelsch-esi

Overview

The Knative project [landing page] redirects to the doc page:
https://knative.dev/docs/. The project landing page contains all the
elements you'd expect on an open-source software page, including case studies,
user endorsements, and links to the community.

It also includes the technical documentation in the banner menu. This
arrangement conflates the project and the technical documentation, mixing
marketing and technical information.

It's helpful to users if there's a clear separation between technical
documentation and other information. The technical documentation is goal-driven
and should be factual, specific, and purposeful.

The request: Separate the technical documentation from the project landing page.

Audience: All

Type: All

Context

This issue tracks recommended changes resulting from an analysis of the Knative
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0015-knative.

Possible Implementation

Related material in the current doc:

Suggested changes:

The simplest solution to untangling the documentation from the landing page is
probably to:

  • Reconfigure the site to use the base URL https://knative.dev as the project
    landing page.
  • Add a "Documentation" tab on the right alongside "Blog," "About," and
    "Community" on the project page that links to the docs page,
    https://knative.dev/docs.
  • Move the tech docs items from the banner to the left-hand sidebar (LHS) on the
    tech docs page.
  • Remove the version drop-down from the project landing page (and the other
    non-documentation project pages).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions