sijie opened a new pull request #2245:  [website] fix javadoc template 
URL: https://github.com/apache/incubator-pulsar/pull/2245
 
 
   ### Motivation
   
   the existing site is using `{% javadoc ... %}` for templating url to the 
javadoc link of a given java class.
   since the new site doesn't use any templating language. we need to fix these 
templates.
   
    ### Changes
   
   I am extending the `inject` logic in markdown rendering, providing a similar 
feature as existing site.
   
   when you want to create a link to a java class, you can use `{@Inject: 
javadoc:<class-name>:<relative-class-path-to-javadoc-location>}`.
   
   Example: if you want to link to 
https://pulsar.incubator.apache.org/api/admin/org/apache/pulsar/client/admin/PulsarAdmin.html,
 you can
   use `{@Inject: 
javadoc:PulsarAdmin:admin/org/apache/pulsar/client/admin/PulsarAdmin}` and the 
rendered result will be
   
   
[PulsarAdmin](https://pulsar.incubator.apache.org/api/admin/org/apache/pulsar/client/admin/PulsarAdmin.html)

----------------------------------------------------------------
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:
[email protected]


With regards,
Apache Git Services

Reply via email to