[GitHub] [incubator-iceberg] rdblue edited a comment on issue #243: Fix mkdocs and add missing footnotes

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

rdblue edited a comment on issue #243: Fix mkdocs and add missing footnotes
URL: https://github.com/apache/incubator-iceberg/pull/243#issuecomment-508862796
 
 
   @jun-he, using `!!! note` blocks adds a large call-out that isn't suitable for footnotes, which should not draw attention. Also, footnote links do not work if you aren't using the footnote plugin and show up in the doc like this: "buckets[^1]".
   
   I recommend running `mkdocs serve` to see how these changes look locally before updating the PR. Also, there are other "Notes" sections that you can look at. Just match the formatting of those.

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


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org