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/13 15:05:20 UTC
[GitHub] [iceberg-docs] samredai opened a new pull request #7: Add javadoc directory and deployment job
samredai opened a new pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7
Since adding the `javadoc` directory includes a lot of files and is obfuscating any paired changes, I'm opening this PR that purely does the following:
- `cp -r` of `iceberg/site/docs/javadoc/0.12.1/` in the proper iceberg repo to a `javadoc` directory in the root of this repo
- Add a `deploy-javadoc` job that copies to a `/javadoc/<branch_name>` directory in the `asf-site` branch
- Adds `!javadoc/resources` to the `.gitignore` file so that this directory is not ignored (`resources` generally is a recommended ignore for hugo projects)
--
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 edited a comment on pull request #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
samredai edited a comment on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012556967
--
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 #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012342737
@RussellSpitzer yes that's right, I would imagine it as part of the process of copying over the markdown files from the main iceberg repo. In other words, the markdown files will be maintained in the site directory in apache/iceberg, and releasing would look like:
1. Copy the markdown files into this repo
2. Generate the javadoc and copy it into this repo
3. Branch from main into a version branch, i.e. `0.13.0`
The deployment workflow will then deploy that version of the site.
--
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 #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
rdblue merged pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7
--
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] RussellSpitzer commented on pull request #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
RussellSpitzer commented on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012294418
Is the idea that on every release we are going to run a cp -r of the java docs to here manually?
--
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 #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012534624
Also, will you follow up with the old javadocs that are currently on the site?
--
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 #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012534323
@samredai is this deployed so I can take a quick look?
--
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 edited a comment on pull request #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
samredai edited a comment on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012556967
@rdblue I just deployed this commit so you can see it in action [here](https://iceberg.redai.dev/). You should be able to test that the current javadoc links aren't broken, for example:
https://iceberg.apache.org/javadoc/0.12.1/org/apache/iceberg/Table.html#expireSnapshots--
`s/apache.org/redai.dev`
https://iceberg.redai.dev/javadoc/0.12.1/org/apache/iceberg/Table.html#expireSnapshots--
Keep in mind that the javadocs links in the markdown pages will be broken for now. I'll fix that in a follow-up PR. That's because `../javadoc` will need to be changed to `../../../javadoc` (to account for the `docs/<version>` included in the versioned doc site.
As for the old javadocs, yes I can follow-up with adding those. It should be as simple as creating a branch for each of the versions and then updating the javadoc root directories in each branch to contain the corresponding javadoc. (we'd also need a `master` branch since the current site includes a set of javadocs for that and we don't want those links to 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] rdblue commented on pull request #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012562447
Thanks, @samredai! Those links were exactly what I was going to check.
--
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 #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012556967
@rdblue I just deployed this commit so you can see it in action [here](https://iceberg.redai.dev/). You should be able to test that the current javadoc links aren't broken, for example `https://iceberg.apache.org/javadoc/0.12.1/org/apache/iceberg/Table.html#expireSnapshots--` -> `s/apache.org/redai.dev` -> `https://iceberg.redai.dev/javadoc/0.12.1/org/apache/iceberg/Table.html#expireSnapshots--`.
Keep in mind that the javadocs links in the markdown pages will be broken for now. I'll fix that in a follow-up PR. That's because `../javadoc` will need to be changed to `../../../javadoc` (to account for the `docs/<version>` included in the versioned doc site.
As for the old javadocs, yes I can follow-up with adding those. It should be as simple as creating a branch for each of the versions and then updating the javadoc root directories in each branch to contain the corresponding javadoc.
--
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 edited a comment on pull request #7: Add javadoc directory and deployment job
Posted by GitBox <gi...@apache.org>.
samredai edited a comment on pull request #7:
URL: https://github.com/apache/iceberg-docs/pull/7#issuecomment-1012556967
--
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