[
https://issues.apache.org/jira/browse/TS-3090?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14297465#comment-14297465
]
Jon Sime commented on TS-3090:
------------------------------
A new Getting Started Guide was checked into the repository and may be viewed
in the official documentation at:
https://docs.trafficserver.apache.org/en/latest/getting-started.en.html
This is intended as a replacement for the first chapter of the existing
Administrator's Guide - separate from that guide and intended to provide a
quick on-boarding process to new users, whereas the admin guide will likely see
changes to keep its focus more firmly on the full range of capabilities offered
by ATS. Additional comments, suggestions, and edits would be most welcome to
continue improving the experience for those new to using and/or administering
ATS.
> docs.trafficserver.apache.org introduces a very high barrier to get started
> ---------------------------------------------------------------------------
>
> Key: TS-3090
> URL: https://issues.apache.org/jira/browse/TS-3090
> Project: Traffic Server
> Issue Type: Improvement
> Components: Documentation
> Reporter: Karl Richter
> Assignee: Jon Sime
> Fix For: Docs
>
>
> Currently the administration guide introduces a unnecessary high barrier to
> get started, examples include
> * mentioning of default configuration in
> https://docs.trafficserver.apache.org/en/latest/admin/getting-started.en.html#start-traffic-server,
> but no link to alternative configurations (how to check out caching
> features?)
> * no overview over different modes and their control (it should be clear
> how to start a caching proxy after reading the caching proxy section or if
> not where to read further)
> * Is it necessary to read about all different types of proxying
> trafficserver offers or can the reader skip the sections about modes which
> are not interesting? Please add a statement.
> There are project where the user just can't get started out-of-the-box and
> that is perfectly fine - there's nothing better sitting in front of the
> chimney and reading a well written manual ;). If this is the case for
> trafficserver please add a statement with a short explanation or state that
> there's no getting started guide for reason X and Y.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
