[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user zentol commented on the issue: https://github.com/apache/flink/pull/3916 updated version: #5119 ---
[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user zentol commented on the issue: https://github.com/apache/flink/pull/3916 That doesn't solve the problem of having to wait 10 minutes for every little change in the docs. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user rmetzger commented on the issue: https://github.com/apache/flink/pull/3916 How about the following: - We commit the generated files to git - We try in build-docs.sh to update the generated files, but a failure won't break the doc build process This way, we have an "eventual consistency" model for the config parameters. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user zentol commented on the issue: https://github.com/apache/flink/pull/3916 I'm not so sure about integrating it directly into the build-docs.sh. That implies that when you run the script you have also have to compile Flink. We can _reduce_ this to at-least-once by adding a brittle mechanism to check for the presence of the files, but that's about it. I was thinking primarily about the website documentation; for this we compile Flink anyway, we just have to build the docs after compilation, and not before. Note that if any file that is supposed to be included in the docs isn't present the build process will straight up fail. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user rmetzger commented on the issue: https://github.com/apache/flink/pull/3916 +1 for integration into the build-docs.sh, we just have to make sure that the docs are still properly build on the buildbot for the flink website. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user zentol commented on the issue: https://github.com/apache/flink/pull/3916 We can leave the generated files out of the codebase, integrating it into the build script should be doable. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user zentol commented on the issue: https://github.com/apache/flink/pull/3916 That's a good point. I'll need to checkout how we're building the docs and whether we can just generate the docs before calling `build-docs.sh`. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] flink issue #3916: [FLINK-6590] Integrate automatic docs generation
Github user dawidwys commented on the issue: https://github.com/apache/flink/pull/3916 I was just wondering if the generated files should be part of the codebase. Shouldn't they only be generated in the build process? --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
