[flang-commits] [PATCH] D87270: [Flang] Add GettingInvolved documentation page and sidebar.

Fri Sep 11 08:11:47 PDT 2020

richard.barton.arm requested changes to this revision.
richard.barton.arm added a comment.
This revision now requires changes to proceed.

Nice one - a good addition to the docs, IMO.

I have requested some detail changes.

================
Comment at: flang/docs/GettingInvolved.md:1
+#### Getting Involved
+
----------------
The heading depths need to be corrected for this to display well in the new index file toctrees. Needs to be # for the top-level section and ## for the subsections.

================
Comment at: flang/docs/GettingInvolved.md:4
+
+**Flang** project welcomes contributions of all kinds.
+Please feel free to join the mailing list of the slack channel for discussions related to development of flang.
----------------
^The Flang Project...

================
Comment at: flang/docs/GettingInvolved.md:5
+**Flang** project welcomes contributions of all kinds.
+Please feel free to join the mailing list of the slack channel for discussions related to development of flang.
+To understand the status of various developments in flang please join the respective call.
----------------
or

================
Comment at: flang/docs/GettingInvolved.md:14
+
+  This list is for people who want to be included in technical discussions related to flang. People post to this list when they have questions about writing code
+  for or using the Flang tools. It is relatively low volume.
----------------
There are some plain text references to Flang (capital F) and flang (lower-case f). Suggest to standardise on one - probably Flang.

================
Comment at: flang/docs/GettingInvolved.md:42
+-   Join [Flang Community Biweekly Call](https://nvmeet.webex.com/nvmeet/j.php?MTID=mb4edb8c799f69ec2dc0554acc969a162)
+-   Time: On Alternate wednesdays 8:30 Pacific Time.
+
----------------
Missing line about the minutes - these are sent by email to flang-dev.

================
Comment at: flang/docs/GettingInvolved.md:49
+-   Time: On Mondays 8:30 Pacific Time, on the weeks alternating with regular Flang biweekly call.
+-   The notes are in this [Google Docs](https://docs.google.com/document/d/1Z2U5UAtJ-Dag5wlMaLaW1KRmNgENNAYynJqLW2j2AZQ/)
+
----------------
*Doc (singular)

================
Comment at: flang/docs/GettingInvolved.md:49
+-   Time: On Mondays 8:30 Pacific Time, on the weeks alternating with regular Flang biweekly call.
+-   The notes are in this [Google Docs](https://docs.google.com/document/d/1Z2U5UAtJ-Dag5wlMaLaW1KRmNgENNAYynJqLW2j2AZQ/)
+
----------------
richard.barton.arm wrote:
> *Doc (singular)
minutes or agenda

================
Comment at: flang/docs/GettingInvolved.md:51
+
+**Classic Flang Biweekly Technical Call**
+
----------------
I don't think we should include this as it could be confusing. I suggest keeping this section for LLVM Flang business only.

================
Comment at: flang/docs/GettingInvolved.md:63
+-   Time: Tuesdays 10:00 AM Pacific Time, every 4 weeks.
+-   [Google Docs](https://docs.google.com/document/d/1ybwEKDVtIbhIhK50qYtwKsL50K-NvB6LfuBsfepBZ9Y/)
+
----------------
Please add some text like the other ones - "Minutes are here ..." or something.

================
Comment at: flang/docs/GettingInvolved.md:67
+
+-   Weekly call on Microsoft Teams every Thursdays 8:00 AM Pacific time.
+-   Join [OpenMP Technical Call](https://bit.ly/39eQW3o)
----------------
Suggest to delete the Teams reference. The conf software is not relevant to this sentence and might change in future as trends change.

================
Comment at: flang/docs/GettingInvolved.md:67
+
+-   Weekly call on Microsoft Teams every Thursdays 8:00 AM Pacific time.
+-   Join [OpenMP Technical Call](https://bit.ly/39eQW3o)
----------------
richard.barton.arm wrote:
> Suggest to delete the Teams reference. The conf software is not relevant to this sentence and might change in future as trends change.
Missing sentence on the purpose of the call.

================
Comment at: flang/docs/GettingInvolved.md:68
+-   Weekly call on Microsoft Teams every Thursdays 8:00 AM Pacific time.
+-   Join [OpenMP Technical Call](https://bit.ly/39eQW3o)
+-   [Meeting Minutes](https://docs.google.com/document/d/1yA-MeJf6RYY-ZXpdol0t7YoDoqtwAyBhFLr5thu5pFI)
----------------
OCD: it would be nice for these all to line up. The other say:

 - Purpose of the call
 - How to join
 - Time of the call
 - Minutes

This one has it in a different order. :-(

================
Comment at: flang/docs/_templates/indexsidebar.html:24
+    <li><a href="https://reviews.llvm.org/">Code Review</a></li>
+<! TODO: Have the bots setup first>
+    <li><a href="#">Doxygen API</a></li>
----------------
Does this comment mean buildbots? Could we link to http://lab.llvm.org:8011/console here?

================
Comment at: flang/docs/conf.py:162
+        'indexsidebar.html',
+#        'sourcelink.html',
+        'searchbox.html',
----------------
Shouldn't commit commented out lines.

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D87270/new/

https://reviews.llvm.org/D87270