Skip to content

Reorganization of the doc pages #1079

Closed
devfile/devfile-web
#86
@michael-valdron

Description

@michael-valdron

Which area this feature is related to?

/area documentation

Which area is this documentation change is related to?

/area landing-page

Issue details

What mistake did you find / what is missing in the documentation?

After reviewing the organization of our doc pages it has become clear that there is a few items of reorganization to be done:

  1. The ordering of our doc page sections needs changing
    • e.g. Getting Started should be second in the ordering after the Introduction section
  2. Review of doc page / section assignment. The order of the sections on the left should be in the order that we think a typical user will read from the top.
    1. Devfile perspective pages Application developer, Enterprise architect and runtime provider, and Registry administrator and Technology and tool builders should be under the General rather than Getting Started. They should be group together as persona docs that are probably referred to at the end of the *Devfile ecosystem
    2. Move **Devfile ecosystem to under General as well
    3. Move General to the third section after Getting Started
    4. Move API reference after General
    5. Move existing General, Events, Components, Commands to 2nd level section and group them under a new section of Authoring devfiles
    6. Move Creating devfiles with templates and Innerloop versus outerloop to the new first level General section, i.e. same level as Devfile ecosystem
  3. Any other changes needed such as section renaming or adding/removal of sections

Target Date: 2023-04-05

Metadata

Metadata

Assignees

Labels

area/documentationImprovements or additions to documentationarea/landing-pageIssues with the Landing Page

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions