You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2020/05/22 13:12:37 UTC
[GitHub] [beam] epicfaace opened a new pull request #11797: [BEAM-10065] Fix beam release guide template
epicfaace opened a new pull request #11797:
URL: https://github.com/apache/beam/pull/11797
Fix beam release guide template so that it shows up, and so that it also highlights syntax in markdown.
It turns out, the `<!--more-->` part of the template was what was causing the display issues.
R: @ibzib
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [ ] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
Post-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
Lang | SDK | Apex | Dataflow | Flink | Gearpump | Samza | Spark
--- | --- | --- | --- | --- | --- | --- | ---
Go | [](https://builds.apache.org/job/beam_PostCommit_Go/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_Go_VR_Flink/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_Go_VR_Spark/lastCompletedBuild/)
Java | [](https://builds.apache.org/job/beam_PostCommit_Java/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Apex/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Java11/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Java11/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink_Batch/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink_Streaming/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Gearpump/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Spark_Batch/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_SparkStructuredStreaming/lastCompletedBuild/)
Python | [](https://builds.apache.org/job/beam_PostCommit_Python2/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python35/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python36/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python37/lastCompletedBuild/) | --- | [](https://builds.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Py_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Python2_PVR_Flink_Cron/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python35_VR_Flink/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_Python_VR_Spark/lastCompletedBuild/)
XLang | --- | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_XVR_Flink/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_XVR_Spark/lastCompletedBuild/)
Pre-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
--- |Java | Python | Go | Website
--- | --- | --- | --- | ---
Non-portable | [](https://builds.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PreCommit_PythonLint_Cron/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Website_Cron/lastCompletedBuild/)
Portable | --- | [](https://builds.apache.org/job/beam_PreCommit_Portable_Python_Cron/lastCompletedBuild/) | --- | ---
See [.test-infra/jenkins/README](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md) for trigger phrase, status and link of all Jenkins jobs.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] ibzib commented on a change in pull request #11797: [BEAM-10065] Fix beam release guide template
Posted by GitBox <gi...@apache.org>.
ibzib commented on a change in pull request #11797:
URL: https://github.com/apache/beam/pull/11797#discussion_r430480420
##########
File path: website/www/site/static/js/language-switch.js
##########
@@ -113,7 +113,7 @@ $(document).ready(function() {
}
// Swapping visibility of code blocks.
- $(this.selector).hide();
+ $(this.selector).not(".language-md").hide();
Review comment:
Why is this change needed?
##########
File path: website/www/site/static/js/language-switch.js
##########
@@ -113,7 +113,7 @@ $(document).ready(function() {
}
// Swapping visibility of code blocks.
- $(this.selector).hide();
+ $(this.selector).not(".language-md").hide();
Review comment:
This is a bigger problem than just markdown. Every code block that specifies a language that is not toggled on will be hidden. I filed BEAM-10092.
For now, since syntax highlighting is not important here, please remove the `md` and we can merge the rest of your changes.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] ibzib merged pull request #11797: [BEAM-10065] Fix beam release guide template
Posted by GitBox <gi...@apache.org>.
ibzib merged pull request #11797:
URL: https://github.com/apache/beam/pull/11797
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] epicfaace commented on a change in pull request #11797: [BEAM-10065] Fix beam release guide template
Posted by GitBox <gi...@apache.org>.
epicfaace commented on a change in pull request #11797:
URL: https://github.com/apache/beam/pull/11797#discussion_r430491681
##########
File path: website/www/site/static/js/language-switch.js
##########
@@ -113,7 +113,7 @@ $(document).ready(function() {
}
// Swapping visibility of code blocks.
- $(this.selector).hide();
+ $(this.selector).not(".language-md").hide();
Review comment:
```suggestion
$(this.selector).hide();
```
##########
File path: website/www/site/static/js/language-switch.js
##########
@@ -113,7 +113,7 @@ $(document).ready(function() {
}
// Swapping visibility of code blocks.
- $(this.selector).hide();
+ $(this.selector).not(".language-md").hide();
Review comment:
Accidentally added that change in -- removing it now
##########
File path: website/www/site/static/js/language-switch.js
##########
@@ -113,7 +113,7 @@ $(document).ready(function() {
}
// Swapping visibility of code blocks.
- $(this.selector).hide();
+ $(this.selector).not(".language-md").hide();
Review comment:
Otherwise, the template (which is in ` ```md`) becomes automatically hidden by this script. We can either add this change in, or we can disable syntax highlighting in the template by replacing ` ```md` with ` ``` `.
##########
File path: website/www/site/static/js/language-switch.js
##########
@@ -113,7 +113,7 @@ $(document).ready(function() {
}
// Swapping visibility of code blocks.
- $(this.selector).hide();
+ $(this.selector).not(".language-md").hide();
Review comment:
I don't think we'll ever have a language switcher with ` ```md ` code blocks, so this change should be safe to add.
##########
File path: website/www/site/static/js/language-switch.js
##########
@@ -113,7 +113,7 @@ $(document).ready(function() {
}
// Swapping visibility of code blocks.
- $(this.selector).hide();
+ $(this.selector).not(".language-md").hide();
Review comment:
```suggestion
$(this.selector).hide();
```
##########
File path: website/www/site/content/en/contribute/release-guide.md
##########
@@ -711,54 +711,54 @@ all major features and bug fixes, and all known issues.
Template:
-```
- We are happy to present the new {$RELEASE_VERSION} release of Beam. This release includes both improvements and new functionality.
- See the [download page](/get-started/downloads/{$DOWNLOAD_ANCHOR}) for this release.<!--more-->
- For more information on changes in {$RELEASE_VERSION}, check out the
- [detailed release notes]({$JIRA_RELEASE_NOTES}).
+```md
Review comment:
```suggestion
```
```
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org