Skip to content

Create "Getting started" document #40

@pkosiec

Description

@pkosiec

Description

Create one single entry point for installing CLI, Capact and running Mattermost example.

  • Create one document which summarizes the content on our website

  • Consider setting it as an entrypoint for documentation

  • Adjust homepage

    • Update "Get Started" button
    • Point "Learn more" button to the entrypoint of the documentation
  • Manually copy that also to release 0.5 documentation directory

    • Does not apply if the Getting started doc have missing sections which should be addressed in a follow-up

Reason

The newcomer experience could be improved. A person navigates to the "Local installation", and then needs to go to "Getting started" CLI guide to install and configure CLI. Then, the person needs to go back to "Local installation", proceed with that and jump to Mattermost example.
We also cannot treat the "Getting started" CLI guide as an entrypoint, as it just describes CLI installation and configuration.

Additional links

Inspiration:

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/communityRelates to all community activitiesarea/documentationRelates to all activities around documentationenhancementNew feature or requestgood first issueGood for newcomershacktoberfestTasks which are a part of Hacktoberfest. Learn more on https://hacktoberfest.digitalocean.com/

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions