Conversation
|
Refer to this link for build results (access rights to CI server needed): |
There was a problem hiding this comment.
https://github.com/apache/trafficcontrol/blob/master/traffic_ops/app/lib/TrafficOpsRoutes.pm#L636
This was most likely a typo meant for that route ☝️ .
There was a problem hiding this comment.
Possibly, and I did consider changing it instead of removing it, but that appears to be removing a delivery service from a federation (which is in line with the method name) whereas the route in the method seems to be trying to remove it from a federation resolver. I don't really have a very good grasp on the difference, so I decided to just remove it rather than try to fix it.
|
is it just me or does this PR seem to do 2 things:
if so, why not 2 PR's? |
|
The fixes to the Python client were motivated by the documentation errors it was generating. There may be other problems with the client, but if it doesn't generate a documentation error, I didn't fix it. |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
This means that POSIX commands link to their respective man pages, Traffic Control terms link to their respective glossary entries, RFC links are maintained by the 'rfc' role rather than hard-coded URLs, PEP links are maintained by the 'pep' role rather than hard-coded URLs, abbreviations are defined using the 'abbr' role and external files are referenced directly as 'download' links instead of just by relative filename in the repository. This change also fixes documentation inconsistencies with the guidelines, as well as fixes for many warnings generated by the inclusion of docstrings from the Python client. Some such warnings still exist because each method of the client links to documentation for the endpoint(s) used, but many of those endpoints do not yet have documentation. The warnings should disappear when said documentation is added - presuming naming convention is followed.
ocket8888
force-pushed
the
text-roles
branch
from
906a1cf to
69ed7d3
Compare
|
Refer to this link for build results (access rights to CI server needed): |
mitchell852
added
Traffic Ops
4 participants
What does this PR do?
This PR fixes numerous warnings and errors generated by the documentation build system, as well as rearranges some things such that most Traffic Control terms now link to a description of said term in the glossary. It also implements proper text roles for things like command line tools and RFC documents. Finally, this PR includes updates to the Python Traffic Ops client to remove methods of the
TOSessionobject that used non-existent API endpoints.Which TC components are affected by this PR?
What is the best way to verify this PR?
Build the documentation and verify that no warnings or errors are emitted.
Check all that apply