You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by GitBox <gi...@apache.org> on 2022/01/14 15:23:52 UTC
[GitHub] [iceberg-docs] samredai opened a new pull request #9: Add javadoc link functionality to calculate /javadocs/
samredai opened a new pull request #9:
URL: https://github.com/apache/iceberg-docs/pull/9
This includes a new front-matter setting `javadocLink` that is a boolean. The link to the javadocs is unique in that it requires a calculation on which javadoc version to link to based on the current version of the docs site the user is looking at. However, site params can't be used directly within front-matter.
So this PR achieves this using the logic in `menu-filetree.html` which is triggered when `javadocLink: true` and uses the following calculation to determine the javadoc site:
`{{ .Page.Site.BaseURL }}/../../javadocs/{{ .Page.Site.Params.versions.iceberg }}`.
As an example:
- A user is on `https://iceberg.apache.org/docs/0.12.1/spark-queries`
- Therefore, `{{ .Page.Site.BaseURL }}` resolves to `https://iceberg.apache.org/docs/0.12.1`
- Also, `{{ .Page.Site.Params.versions.iceberg }}` resolves to `0.12.1`
- So then `{{ .Page.Site.BaseURL }}/../../javadocs/{{ .Page.Site.Params.versions.iceberg }}` resolves to `https://iceberg.apache.org/docs/0.12.1/../../javadocs/0.12.1` which is `https://iceberg.apache.org/javadocs/0.12.1`
--
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.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
[GitHub] [iceberg-docs] rdblue merged pull request #9: Add javadoc link functionality to calculate /javadocs/
Posted by GitBox <gi...@apache.org>.
rdblue merged pull request #9:
URL: https://github.com/apache/iceberg-docs/pull/9
--
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.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
[GitHub] [iceberg-docs] samredai commented on pull request #9: Add javadoc link functionality to calculate /javadocs/
Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #9:
URL: https://github.com/apache/iceberg-docs/pull/9#issuecomment-1013227764
This commit is currently deployed [here](https://iceberg.redai.dev/) so you can test this out by:
- Going to the latest docs site: https://iceberg.redai.dev/docs/latest/
- In the left nav, clicking `API -> Javadocs`, ensuring that it takes you to https://iceberg.redai.dev/javadocs/latest/
- Going to the 0.12.1 docs site: https://iceberg.redai.dev/docs/0.12.1/
- In the left nav, clicking `API -> Javadocs`, ensuring that it takes you to https://iceberg.redai.dev/javadocs/0.12.1/
--
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.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org