limited closed pull request #2427: Clean up docs, incubator and conf.py for PDF URL: https://github.com/apache/trafficcontrol/pull/2427
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/docs/source/_static/bad.png b/docs/source/_static/bad.png new file mode 100644 index 000000000..485e3da77 Binary files /dev/null and b/docs/source/_static/bad.png differ diff --git a/docs/source/_static/clock-black.png b/docs/source/_static/clock-black.png new file mode 100644 index 000000000..4783c01bd Binary files /dev/null and b/docs/source/_static/clock-black.png differ diff --git a/docs/source/_static/clock.png b/docs/source/_static/clock.png new file mode 100644 index 000000000..a4a5f1f73 Binary files /dev/null and b/docs/source/_static/clock.png differ diff --git a/docs/source/_static/good.png b/docs/source/_static/good.png new file mode 100644 index 000000000..84d96cde8 Binary files /dev/null and b/docs/source/_static/good.png differ diff --git a/docs/source/_static/graph.png b/docs/source/_static/graph.png new file mode 100644 index 000000000..4502a2d14 Binary files /dev/null and b/docs/source/_static/graph.png differ diff --git a/docs/source/_static/info.png b/docs/source/_static/info.png new file mode 100644 index 000000000..3e1125c8d Binary files /dev/null and b/docs/source/_static/info.png differ diff --git a/docs/source/_static/warning.png b/docs/source/_static/warning.png new file mode 100644 index 000000000..57cccda1c Binary files /dev/null and b/docs/source/_static/warning.png differ diff --git a/docs/source/admin/traffic_ops/default_profiles.rst b/docs/source/admin/traffic_ops/default_profiles.rst index 9b629be7e..75a71d290 100644 --- a/docs/source/admin/traffic_ops/default_profiles.rst +++ b/docs/source/admin/traffic_ops/default_profiles.rst @@ -24,7 +24,7 @@ Traffic Ops - Default Profiles Traffic Ops has the concept of :ref:`rl-working-with-profiles`, which are an integral function within Traffic Ops. To get started, a set of default Traffic Ops profiles need to be imported into Traffic Ops to get started to support Traffic Control components Traffic Router, Traffic Monitor, and Apache Traffic Server. -`Download Default Profiles from here <http://trafficcontrol.incubator.apache.org/downloads/profiles/>`_ +`Download Default Profiles from here <http://trafficcontrol.apache.org/downloads/profiles/>`_ .. _rl-to-profiles-min-needed: diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst index c7273e5e8..97e20cbf6 100644 --- a/docs/source/admin/traffic_ops/using.rst +++ b/docs/source/admin/traffic_ops/using.rst @@ -13,11 +13,11 @@ .. limitations under the License. .. -.. |graph| image:: ../../../../traffic_ops/app/public/images/graph.png -.. |info| image:: ../../../../traffic_ops/app/public/images/info.png -.. |checkmark| image:: ../../../../traffic_ops/app/public/images/good.png -.. |X| image:: ../../../../traffic_ops/app/public/images/bad.png -.. |clock| image:: ../../../../traffic_ops/app/public/images/clock-black.png +.. |graph| image:: ../../_static/graph.png +.. |info| image:: ../../_static//info.png +.. |checkmark| image:: ../../_static/good.png +.. |X| image:: ../../_static/bad.png +.. |clock| image:: ../../_static/clock-black.png Traffic Ops - Using %%%%%%%%%%%%%%%%%%% diff --git a/docs/source/admin/traffic_server.rst b/docs/source/admin/traffic_server.rst index 828cb4706..d4b817e25 100644 --- a/docs/source/admin/traffic_server.rst +++ b/docs/source/admin/traffic_server.rst @@ -25,11 +25,11 @@ Installing Traffic Server #. Build the astats RPM using the appropriate version number: :: - https://github.com/apache/incubator-trafficcontrol/tree/<version>/traffic_server + https://github.com/apache/trafficcontrol/tree/<version>/traffic_server Sample link: :: - https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_server + https://github.com/apache/trafficcontrol/tree/master/traffic_server #. Install Traffic Server and astats: :: diff --git a/docs/source/admin/traffic_stats.rst b/docs/source/admin/traffic_stats.rst index a1d20b39c..d484f59d2 100644 --- a/docs/source/admin/traffic_stats.rst +++ b/docs/source/admin/traffic_stats.rst @@ -25,7 +25,7 @@ Installation **Installing Traffic Stats:** - See the `downloads <https://trafficcontrol.apache.org/downloads/index.html>`_ page for Traffic Control to get the latest release. - - Follow our build `intructions <https://github.com/apache/incubator-trafficcontrol/tree/master/build>`_ to generate an RPM. + - Follow our build `intructions <https://github.com/apache/trafficcontrol/tree/master/build>`_ to generate an RPM. - Copy the RPM to your server - perform the following command: ``sudo rpm -ivh <traffic_stats rpm>`` @@ -89,7 +89,7 @@ Configuration In order for Traffic Ops users to see Grafana graphs, Grafana will need to allow anonymous access. Information on how to configure anonymous access can be found on the configuration page of the `Grafana Website <http://docs.grafana.org/installation/configuration/#authanonymous>`_. - Traffic Ops uses custom dashboards to display information about individual delivery services or cache groups. In order for the custom graphs to display correctly, the `traffic_ops_*.js <https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_stats/grafana/>`_ files need to be in the ``/usr/share/grafana/public/dashboards/`` directory on the grafana server. If your Grafana server is the same as your Traffic Stats server the RPM install process will take care of putting the files in place. If your grafana server is different from your Traffic Stats server, you will need to manually copy the files to the correct directory. + Traffic Ops uses custom dashboards to display information about individual delivery services or cache groups. In order for the custom graphs to display correctly, the `traffic_ops_*.js <https://github.com/apache/trafficcontrol/blob/master/traffic_stats/grafana/>`_ files need to be in the ``/usr/share/grafana/public/dashboards/`` directory on the grafana server. If your Grafana server is the same as your Traffic Stats server the RPM install process will take care of putting the files in place. If your grafana server is different from your Traffic Stats server, you will need to manually copy the files to the correct directory. More information on custom scripted graphs can be found in the `scripted dashboards <http://docs.grafana.org/reference/scripting/>`_ section of the Grafana documentation. diff --git a/docs/source/admin/traffic_vault.rst b/docs/source/admin/traffic_vault.rst index 2f6508a37..ead37a32c 100644 --- a/docs/source/admin/traffic_vault.rst +++ b/docs/source/admin/traffic_vault.rst @@ -167,7 +167,7 @@ One time configuration: ``riak-admin security grant riak_core.set_bucket on any to admin`` 2. Add the search schema to Riak. This schema is a simple Apache Solr configuration file which will index all records on cdn, hostname, and deliveryservice. - * Get the schema file by either cloning the project and going to `traffic_ops/app/config/misc/riak_search` or from `github <https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_ops/app/conf/misc/riak_search>`_. + * Get the schema file by either cloning the project and going to `traffic_ops/app/config/misc/riak_search` or from `github <https://github.com/apache/trafficcontrol/tree/master/traffic_ops/app/conf/misc/riak_search>`_. * Use curl to add the schema to riak: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/search/schema/sslkeys"; -H 'Content-Type:application/xml' -d @sslkeys.xml`` 3. Add search index to Riak diff --git a/docs/source/api/traffic_ops_api.rst b/docs/source/api/traffic_ops_api.rst index 0ced0ae2d..74649a5bd 100644 --- a/docs/source/api/traffic_ops_api.rst +++ b/docs/source/api/traffic_ops_api.rst @@ -193,4 +193,4 @@ The 3 most common errors returned by Traffic Ops are: TrafficOps Native Client Libraries ---------------------------------- -TrafficOps client libraries are available in both Golang and Python. You can read more about them at https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_control/clients +TrafficOps client libraries are available in both Golang and Python. You can read more about them at https://github.com/apache/trafficcontrol/tree/master/traffic_control/clients diff --git a/docs/source/api/v11/cdn.rst b/docs/source/api/v11/cdn.rst index 91c926cc1..f1fd2b4de 100644 --- a/docs/source/api/v11/cdn.rst +++ b/docs/source/api/v11/cdn.rst @@ -384,7 +384,7 @@ Metrics **GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end** -*Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/incubator-trafficcontrol/issues/2309* +*Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/trafficcontrol/issues/2309* Retrieves edge metrics of one or all locations (cache groups). diff --git a/docs/source/api/v12/cdn.rst b/docs/source/api/v12/cdn.rst index 7cdf9b084..9bf791f97 100644 --- a/docs/source/api/v12/cdn.rst +++ b/docs/source/api/v12/cdn.rst @@ -642,7 +642,7 @@ Metrics **GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end** -*Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/incubator-trafficcontrol/issues/2309* +*Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/trafficcontrol/issues/2309* Retrieves edge metrics of one or all locations (cache groups). diff --git a/docs/source/conf.py b/docs/source/conf.py index 5df82cae6..9c22d152d 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,8 +33,8 @@ # -- Project information ----------------------------------------------------- project = 'Traffic Control' -copyright = '2018, jvd' -author = 'jvd' +copyright = '2018, Apache Traffic Control' +author = 'Apache Traffic Control' # The short X.Y version version = '' @@ -141,8 +141,8 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'trafficcontrol.tex', 'trafficcontrol Documentation', - 'jvd', 'manual'), + (master_doc, 'trafficcontrol.tex', 'Apache Traffic Control Documentation', + 'Apache Traffic Control', 'manual'), ] @@ -151,7 +151,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'trafficcontrol', 'trafficcontrol Documentation', + (master_doc, 'Apache Traffic Control', 'Apache Traffic Control Documentation', [author], 1) ] diff --git a/docs/source/development/building.rst b/docs/source/development/building.rst index 87e68e99b..ddd6f0056 100644 --- a/docs/source/development/building.rst +++ b/docs/source/development/building.rst @@ -62,7 +62,7 @@ If any project names are provided on the command line, only those will be built. Otherwise, all projects are built. All artifacts (rpms, logs, source tar ball) are copied to ``dist`` at the top level of the -``incubator-trafficcontrol`` directory. +``trafficcontrol`` directory. Example ~~~~~~~ diff --git a/docs/source/development/traffic_monitor.rst b/docs/source/development/traffic_monitor.rst index 552500cbc..74ac42159 100644 --- a/docs/source/development/traffic_monitor.rst +++ b/docs/source/development/traffic_monitor.rst @@ -281,8 +281,8 @@ Installing The Developer Environment To install the Traffic Monitor Developer environment: 1. Install `go` version 1.7 or greater, from https://golang.org/doc/install and https://golang.org/doc/code.html -2. Clone the traffic_control repository using Git, into ``$GOPATH/src/github.com/apache/incubator-trafficcontrol`` -3. Change directories into ``$GOPATH/src/github.com/apache/incubator-trafficcontrol/traffic_monitor_golang/traffic_monitor`` +2. Clone the trafficcontrol repository using Git, into ``$GOPATH/src/github.com/apache/trafficcontrol`` +3. Change directories into ``$GOPATH/src/github.com/apache/trafficcontrol/traffic_monitor_golang/traffic_monitor`` 4. Run ``./build.sh`` Test Cases diff --git a/docs/source/development/traffic_ops.rst b/docs/source/development/traffic_ops.rst index cb4333059..9bab72de7 100644 --- a/docs/source/development/traffic_ops.rst +++ b/docs/source/development/traffic_ops.rst @@ -167,7 +167,7 @@ Installing The Developer Environment ==================================== To install the Traffic Ops Developer environment: -1. Clone the traffic_control repository from `github.com <https://github.com/apache/incubator-trafficcontrol>`_. +1. Clone the trafficcontrol repository from `github.com <https://github.com/apache/trafficcontrol>`_. 2. Install the local dependencies using Carton (cpanfile). :: @@ -280,9 +280,9 @@ Check Extensions In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the "Health->Server Checks" view and that usually run periodically out of cron. -.. |checkmark| image:: ../../../traffic_ops/app/public/images/good.png +.. |checkmark| image:: ../_static/good.png -.. |X| image:: ../../../traffic_ops/app/public/images/bad.png +.. |X| image:: ../_static/bad.png It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results. diff --git a/docs/source/faq/development.rst b/docs/source/faq/development.rst index 8518eebe5..8d6f703c8 100644 --- a/docs/source/faq/development.rst +++ b/docs/source/faq/development.rst @@ -18,4 +18,4 @@ Development How can I become involved? ========================== - See our `CONTRIBUTING <https://github.com/apache/incubator-trafficcontrol/blob/master/CONTRIBUTING.md>`_ page. + See our `CONTRIBUTING <https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md>`_ page. diff --git a/docs/source/faq/general.rst b/docs/source/faq/general.rst index fe77e3afc..7efa10eb6 100644 --- a/docs/source/faq/general.rst +++ b/docs/source/faq/general.rst @@ -36,7 +36,7 @@ Who is using Traffic Control? How do I get help with Traffic Control? ======================================= - Hop on to our Slack Channel by filling out `this form <https://goo.gl/Suzakj>`_, or send a question to our mailing list `here <mailto:us...@trafficcontrol.incubator.apache.org>`_. + Hop on to our Slack Channel by filling out `this form <https://goo.gl/Suzakj>`_, or send a question to our mailing list `here <mailto:us...@trafficcontrol.apache.org>`_. What is Rascal? =============== ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
