Change in docs[master]: Documentation outline for ALTO


Y. Richard Yang
 

Dear team,

The previous draft doc is under review.

---------- Forwarded message ----------
From: Gerrit Code Review <gerrit@...>
Date: Wed, Apr 22, 2015 at 3:26 PM
Subject: Change in docs[master]: Documentation outline for ALTO
To: "Y. Richard Yang" <yry@...>
Cc: jenkins-releng <jenkins-releng@...>


From Colin Dixon <colin@...>:

Colin Dixon has posted comments on this change.

Change subject: Documentation outline for ALTO
......................................................................


Patch Set 1: Code-Review-1

(12 comments)

https://urldefense.proofpoint.com/v2/url?u=https-3A__git.opendaylight.org_gerrit_-23_c_18389_1_manuals_developer-2Dguide_src_main_asciidoc_alto_odl-2Dalto-2Ddev.adoc&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=D35NWM92fBUnkmeSyaLexFvNuCmT4NwscKmztd5pU_E&e=
File manuals/developer-guide/src/main/asciidoc/alto/odl-alto-dev.adoc:

Line 4: (1) a northbound interface based on RFC7285 to provide ALTO services
      : to ALTO clients; and (2) an ALTO manager so that a network administrator can
      : provision the data of the services.
call these out as bullets by putting a period-space in front of them and putting them on their own line?


Line 18: OpenDayLight
OpenDaylight


https://urldefense.proofpoint.com/v2/url?u=https-3A__git.opendaylight.org_gerrit_-23_c_18389_1_manuals_install-2Dguide_src_main_asciidoc_alto_alto-2Dinstall.adoc&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=LuHNUoEXeIEJPzhA7kOOGCtaJEEW3zpthA1PkYrK1hk&e=
File manuals/install-guide/src/main/asciidoc/alto/alto-install.adoc:

In general if all that's required for installation is installing features, we just put that together in one big table rather than requiring each project list pretty much exactly the same information.


https://urldefense.proofpoint.com/v2/url?u=https-3A__git.opendaylight.org_gerrit_-23_c_18389_1_manuals_user-2Dguide_src_main_asciidoc_alto_odl-2Dalto-2Duser.adoc&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=Yvx2v5V0Nb36VXvCPD5Gye9Hs6C6JyyoFIEEiUwfccE&e=
File manuals/user-guide/src/main/asciidoc/alto/odl-alto-user.adoc:

Line 1: == ALTO User Guide
Does it make sense to expand the ALTO acronym?


Line 2: northbound
what do you mean by northbound?


Line 3: user
section instead of user?


Line 2: ALTO
      : administrator
"an ALTO administrator"? or "ALTO administrators"?


Line 11: the
reachable at?


Line 11: OpenDayLight
OpenDaylight


Line 13: curl -u karaf:karaf -X GET -D - https://urldefense.proofpoint.com/v2/url?u=http-3A__localhost-3A8181_controller_nb_v2_alto_&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=GuQGl6NRLYSPEVvCB4hH2vxOL5aV-cA8ka6FDUbSn-0&e=
My guess is that you want this to be on its own line and thus you want a blank line before it. You might also put it in inside pluses (+) or put a space in front of it to get it to format in a fixed-width font.


Line 16: CI
expand the acronym?


Line 22: * [https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.opendaylight.org_mailman_listinfo_alto-2Ddev&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=3qhCzWQpO_tYa-hrvSlPodxt7JREw1Sgsz29jywm8yU&e=  alto-dev], a general developers list
This format is wiki syntax, not AsciiDoc, the AsciiDoc would be:

https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.opendaylight.org_mailman_listinfo_alto-2Ddev-5Balto-2Ddev&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=XIVkEA7DNBLcXnhOyxPEmaU0hxCprEgSbuUJEWey4tc&e= ]


--
To view, visit https://urldefense.proofpoint.com/v2/url?u=https-3A__git.opendaylight.org_gerrit_18389&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=S9cuOJYt1voEA3jNbvXvy8zOnQgG-kNajJFmEii2kAw&e=
To unsubscribe, visit https://urldefense.proofpoint.com/v2/url?u=https-3A__git.opendaylight.org_gerrit_settings&d=AwIDaQ&c=-dg2m7zWuuDZ0MUcV7Sdqw&r=4G36iiEVb2m_v-0RnP2gx9KZJjYQgfvrOCE3789JGIA&m=aUmHoN4pOkfQQEnvVkjF-WbjB1qrcjgllVXxWsJTGvk&s=1OOh-HcQ3PyRlFQM-j5FcvBDv2F3wkKwlO7uU7YR_sQ&e=

Gerrit-MessageType: comment
Gerrit-Change-Id: I1fbe435b5fdf541d47119a512b664ae618b54416
Gerrit-PatchSet: 1
Gerrit-Project: docs
Gerrit-Branch: master
Gerrit-Owner: Y. Richard Yang <yry@...>
Gerrit-Reviewer: Colin Dixon <colin@...>
Gerrit-Reviewer: jenkins-releng <jenkins-releng@...>
Gerrit-HasComments: Yes



--
-- 
 =====================================
| Y. Richard Yang <yry@...>   |
| Professor of Computer Science       |
 =====================================