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/11 05:39:52 UTC
[GitHub] [iceberg-docs] samredai opened a new pull request #4: Add javadocs
samredai opened a new pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4
This adds the 0.12.1 javadocs and a `deploy-javadocs` job. Deploying the javadocs essentially means copying the contents of the root `javadocs` directory into a `javadocs/<branch_name>` in the `asf-site` branch where <branch_name> could be 0.12.1 for example.
This also adds some hugo logic to include a Javadoc link in the API section of the left navbar that links to the appropriate javadoc (for example if you're on the `/docs/0.12.1` site, then the API->Javadocs link on the left navbar sends you to `/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] samredai closed pull request #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
samredai closed pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4
--
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 commented on a change in pull request #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#discussion_r783345037
##########
File path: docs/content/docs/flink/flink-getting-started.md
##########
@@ -481,7 +481,7 @@ stream.print();
env.execute("Test Iceberg Batch Read");
```
-There are other options that we could set by Java API, please see the [FlinkSource#Builder](../javadoc/{{% icebergVersion %}}/org/apache/iceberg/flink/source/FlinkSource.html).
Review comment:
Can we deploy Javadocs in the same locations so that we don't break the existing URIs?
--
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 #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#issuecomment-1013243450
Thanks @rdblue ! Instead of rebasing, I broke this into smaller pieces in PR #9 #10 #11 and #12 so I'm going to close this.
--
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 commented on pull request #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#issuecomment-1012639646
#7 was merged!
--
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 commented on a change in pull request #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#discussion_r783432076
##########
File path: docs/content/docs/flink/flink-getting-started.md
##########
@@ -481,7 +481,7 @@ stream.print();
env.execute("Test Iceberg Batch Read");
```
-There are other options that we could set by Java API, please see the [FlinkSource#Builder](../javadoc/{{% icebergVersion %}}/org/apache/iceberg/flink/source/FlinkSource.html).
Review comment:
We also need to make sure that none of the existing Javadoc links break.
--
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 #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#issuecomment-1012225340
Will rebase this after PR #7 is merged
--
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 #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#issuecomment-1010591221
@rdblue @jackye1995
--
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 a change in pull request #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
samredai commented on a change in pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#discussion_r783427504
##########
File path: docs/content/docs/flink/flink-getting-started.md
##########
@@ -481,7 +481,7 @@ stream.print();
env.execute("Test Iceberg Batch Read");
```
-There are other options that we could set by Java API, please see the [FlinkSource#Builder](../javadoc/{{% icebergVersion %}}/org/apache/iceberg/flink/source/FlinkSource.html).
Review comment:
Fixed! I also added a redirect for `iceberg.apache.org/javadoc` -> `iceberg.apache.org/javadoc/latest`
--
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 a change in pull request #4: Add javadocs
Posted by GitBox <gi...@apache.org>.
samredai commented on a change in pull request #4:
URL: https://github.com/apache/iceberg-docs/pull/4#discussion_r783378859
##########
File path: docs/content/docs/flink/flink-getting-started.md
##########
@@ -481,7 +481,7 @@ stream.print();
env.execute("Test Iceberg Batch Read");
```
-There are other options that we could set by Java API, please see the [FlinkSource#Builder](../javadoc/{{% icebergVersion %}}/org/apache/iceberg/flink/source/FlinkSource.html).
Review comment:
Ah, you mean `javadoc` as opposed to `javadocs`? Thanks for catching that, not sure how I missed that!
--
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