You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@trafficcontrol.apache.org by ocket 8888 <oc...@gmail.com> on 2021/08/31 22:16:54 UTC

Proposal: Remove "Installation" Wiki section

This section has a single sub-heading:
Installation Gotchas

   - Criteria for the first-time snapshot is not clear. We should clearly
   state what is required (edge, mid, DS)
   - Servers are set to ONLINE Instead of REPORTED leads to health checks
   not working


The meaning of the "criteria for the first-time snapshot is not clear" is
unclear to me - is it saying we should document the minimum required
configuration of ATC objects that must exist for a CDN to serve content
successfully? I would argue that through the docs' "CDN Basics" and
"Overview" sections and by defining what a Delivery Service and a Cache
Server are, we have already accomplished that.

Likewise "Servers are set to ONLINE Instead of REPORTED leads to health
checks not working" seems to be already covered by the definitions of
ONLINE and REPORTED in the official documentation; ONLINE ignores health
checks by design.

Since these are already covered by existing documentation, IMO, we can just
get rid of this section without needing to transfer it.

Re: Proposal: Remove "Installation" Wiki section

Posted by ocket 8888 <oc...@gmail.com>.
The page is now a redirect to
https://traffic-control-cdn.readthedocs.io/en/latest/admin/index.html

On Tue, Aug 31, 2021 at 7:44 PM Zach Hoffman <zr...@apache.org> wrote:

> > Since these are already covered by existing documentation, IMO, we can
> just
> get rid of this section without needing to transfer it.
>
> Agreed that we don't need to copy it to the wiki, but IMO this page should
> link to the relevant section of our documentation instead of being deleted.
>
>
> On Tue, Aug 31, 2021 at 4:17 PM ocket 8888 <oc...@gmail.com> wrote:
>
> > This section has a single sub-heading:
> > Installation Gotchas
> >
> >    - Criteria for the first-time snapshot is not clear. We should clearly
> >    state what is required (edge, mid, DS)
> >    - Servers are set to ONLINE Instead of REPORTED leads to health checks
> >    not working
> >
> >
> > The meaning of the "criteria for the first-time snapshot is not clear" is
> > unclear to me - is it saying we should document the minimum required
> > configuration of ATC objects that must exist for a CDN to serve content
> > successfully? I would argue that through the docs' "CDN Basics" and
> > "Overview" sections and by defining what a Delivery Service and a Cache
> > Server are, we have already accomplished that.
> >
> > Likewise "Servers are set to ONLINE Instead of REPORTED leads to health
> > checks not working" seems to be already covered by the definitions of
> > ONLINE and REPORTED in the official documentation; ONLINE ignores health
> > checks by design.
> >
> > Since these are already covered by existing documentation, IMO, we can
> just
> > get rid of this section without needing to transfer it.
> >
>

Re: Proposal: Remove "Installation" Wiki section

Posted by Zach Hoffman <zr...@apache.org>.
> Since these are already covered by existing documentation, IMO, we can
just
get rid of this section without needing to transfer it.

Agreed that we don't need to copy it to the wiki, but IMO this page should
link to the relevant section of our documentation instead of being deleted.


On Tue, Aug 31, 2021 at 4:17 PM ocket 8888 <oc...@gmail.com> wrote:

> This section has a single sub-heading:
> Installation Gotchas
>
>    - Criteria for the first-time snapshot is not clear. We should clearly
>    state what is required (edge, mid, DS)
>    - Servers are set to ONLINE Instead of REPORTED leads to health checks
>    not working
>
>
> The meaning of the "criteria for the first-time snapshot is not clear" is
> unclear to me - is it saying we should document the minimum required
> configuration of ATC objects that must exist for a CDN to serve content
> successfully? I would argue that through the docs' "CDN Basics" and
> "Overview" sections and by defining what a Delivery Service and a Cache
> Server are, we have already accomplished that.
>
> Likewise "Servers are set to ONLINE Instead of REPORTED leads to health
> checks not working" seems to be already covered by the definitions of
> ONLINE and REPORTED in the official documentation; ONLINE ignores health
> checks by design.
>
> Since these are already covered by existing documentation, IMO, we can just
> get rid of this section without needing to transfer it.
>

Re: Proposal: Remove "Installation" Wiki section

Posted by Zach Hoffman <zr...@apache.org>.
> Since these are already covered by existing documentation, IMO, we can
just
get rid of this section without needing to transfer it.

Agreed that we don't need to copy it to the wiki, but IMO this page should
link to the relevant section of our documentation instead of being deleted.


On Tue, Aug 31, 2021 at 4:17 PM ocket 8888 <oc...@gmail.com> wrote:

> This section has a single sub-heading:
> Installation Gotchas
>
>    - Criteria for the first-time snapshot is not clear. We should clearly
>    state what is required (edge, mid, DS)
>    - Servers are set to ONLINE Instead of REPORTED leads to health checks
>    not working
>
>
> The meaning of the "criteria for the first-time snapshot is not clear" is
> unclear to me - is it saying we should document the minimum required
> configuration of ATC objects that must exist for a CDN to serve content
> successfully? I would argue that through the docs' "CDN Basics" and
> "Overview" sections and by defining what a Delivery Service and a Cache
> Server are, we have already accomplished that.
>
> Likewise "Servers are set to ONLINE Instead of REPORTED leads to health
> checks not working" seems to be already covered by the definitions of
> ONLINE and REPORTED in the official documentation; ONLINE ignores health
> checks by design.
>
> Since these are already covered by existing documentation, IMO, we can just
> get rid of this section without needing to transfer it.
>