You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/04/07 14:55:28 UTC

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #5719: LICENSE file percent coverage GitHub Action

ocket8888 commented on a change in pull request #5719:
URL: https://github.com/apache/trafficcontrol/pull/5719#discussion_r608730431



##########
File path: docs/source/development/godocs.rst
##########
@@ -0,0 +1,57 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+..     http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+******
+Godocs
+******
+
+Linking to Godocs
+=================
+
+As mentioned in :ref:`docs-guide`, you can use the ``:docs-godoc:`` role, the ``:docs-atc-godoc:`` role, and the ``:docs-to-godoc:`` role to link to Godocs from the ATC documentation.

Review comment:
       there's no `docs-` prefix on those roles




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org