[GitHub] [flink] sjwiesman opened a new pull request #15008: [FLINK-21489][docs] Hugo docs add two anchor links to headers 68f3679

[GitBox <gi...@apache.org>]

sjwiesman opened a new pull request #15008:
URL: https://github.com/apache/flink/pull/15008


   ## What is the purpose of the change
   
   Fixes the double anchors in the documentation. Hugo already adds anchor tags so we update `anchor.js` to only add them to the auto-generated configuration files. 
   
   


----------------------------------------------------------------
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] [flink] flinkbot commented on pull request #15008: [FLINK-21489][docs] Hugo docs add two anchor links to headers 68f3679

[GitBox <gi...@apache.org>]

flinkbot commented on pull request #15008:
URL: https://github.com/apache/flink/pull/15008#issuecomment-785157689


   Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
   to review your pull request. We will use this comment to track the progress of the review.
   
   
   ## Automated Checks
   Last check on commit bfc380e2058a3d120b8d7b7c3d00d95071d7b3c3 (Wed Feb 24 15:29:44 UTC 2021)
   
   **Warnings:**
    * No documentation files were touched! Remember to keep the Flink docs up to date!
   
   
   <sub>Mention the bot in a comment to re-run the automated checks.</sub>
   ## Review Progress
   
   * ❓ 1. The [description] looks good.
   * ❓ 2. There is [consensus] that the contribution should go into to Flink.
   * ❓ 3. Needs [attention] from.
   * ❓ 4. The change fits into the overall [architecture].
   * ❓ 5. Overall code [quality] is good.
   
   Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
    The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
    - `@flinkbot approve all` to approve all aspects
    - `@flinkbot approve-until architecture` to approve everything until `architecture`
    - `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
    - `@flinkbot disapprove architecture` to remove an approval you gave earlier
   </details>


----------------------------------------------------------------
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] [flink] aljoscha commented on a change in pull request #15008: [FLINK-21489][docs] Hugo docs add two anchor links to headers 68f3679

[GitBox <gi...@apache.org>]

aljoscha commented on a change in pull request #15008:
URL: https://github.com/apache/flink/pull/15008#discussion_r582067399



##########
File path: docs/static/js/flink.js
##########
@@ -174,5 +174,5 @@ document.addEventListener("DOMContentLoaded", function(event) {
     anchors.options = {
         placement: 'right'
     };
-    anchors.add();
-});
\ No newline at end of file
+    anchors.add('h5');

Review comment:
       ```suggestion
       // add anchors to h5 headings, hugo already adds them to h1-h4 but we use h5 in generated documentation
       anchors.add('h5');
   ```




----------------------------------------------------------------
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] [flink] sjwiesman closed pull request #15008: [FLINK-21489][docs] Hugo docs add two anchor links to headers 68f3679

[GitBox <gi...@apache.org>]

sjwiesman closed pull request #15008:
URL: https://github.com/apache/flink/pull/15008


   


----------------------------------------------------------------
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