Skip to content

Commit fe395ae

Browse files
sameeran joshiSameeranjoshi
sameeran joshi
authored andcommitted
[Flang] Add GettingInvolved documentation page and sidebar.
Adds a new GettingInvolved page to documentation which provides details about mailing list, chats and calls. Adds a sidebar page which provides common links on all documentation pages. The links include: - Getting Started - Getting Involved - Github Repository - Bug Reports - Code Review Depends on https://reviews.llvm.org/D87242 Reviewed By: richard.barton.arm Differential Revision: https://reviews.llvm.org/D87270
1 parent db22e70 commit fe395ae

File tree

5 files changed

+120
-1
lines changed

5 files changed

+120
-1
lines changed

flang/docs/GettingInvolved.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<!--===- docs/GettingInvolved.md
2+
3+
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4+
See https://llvm.org/LICENSE.txt for license information.
5+
SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
7+
-->
8+
# Getting Involved
9+
10+
```eval_rst
11+
.. contents::
12+
:local:
13+
```
14+
15+
The Flang Project welcomes contributions of all kinds.
16+
Please feel free to join the mailing list or the slack channel for discussions related to development of Flang.
17+
To understand the status of various developments in Flang please join the respective call.
18+
19+
## Mailing Lists
20+
21+
[Developer's List (flang-dev)](http://lists.llvm.org/mailman/listinfo/flang-dev)
22+
23+
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
24+
for or using the Flang tools. It is relatively low volume.
25+
26+
27+
[Commits Archive (flang-commits)](http://lists.llvm.org/pipermail/flang-commits)
28+
29+
This list contains all commit messages that are made when Flang developers
30+
commit code changes to the repository. It also serves as a forum for
31+
patch review (i.e. send patches here). It is useful for those who want to
32+
stay on the bleeding edge of Flang development. This list is high
33+
volume.
34+
35+
## Chat
36+
37+
### Flang Slack Workspace
38+
39+
- There is a Slack workspace dedicated to Flang.
40+
- There are a number of topic-oriented channels available (e.g., #driver, #f18-semantics, #fir).
41+
- Add yourself via the *[invitation link](https://join.slack.com/t/flang-compiler/shared_invite/zt-2pcn51lh-VrRQL_YUOkxA_1CEfMGQhw "title")*
42+
43+
## Calls
44+
45+
### Flang Community Biweekly Call
46+
47+
- General updates on the Flang Project, both LLVM Flang and current Flang.
48+
- Join [Flang Community Biweekly Call](https://nvmeet.webex.com/nvmeet/j.php?MTID=mb4edb8c799f69ec2dc0554acc969a162)
49+
- Time: On Wednesdays 8:30 Pacific Time, on the weeks alternating with regular Flang Community Technical Biweekly Call.
50+
- Minutes: They are sent to [flang-dev](http://lists.llvm.org/mailman/listinfo/flang-dev). Search for `Flang Biweekly Sync - Notes`.
51+
52+
### Flang Community Technical Biweekly Call
53+
54+
- Technical topics call.
55+
- Join [Flang Community Technical Biweekly Call](https://bluejeans.com/625064848?src=join_info)
56+
- Time: On Mondays 8:30 Pacific Time, on the weeks alternating with regular Flang Community Biweekly Call.
57+
- The agenda is in this [Google Doc](https://docs.google.com/document/d/1Z2U5UAtJ-Dag5wlMaLaW1KRmNgENNAYynJqLW2j2AZQ/).
58+
59+
### LLVM Alias Analysis Technical Call
60+
61+
- For people working on improvements to LLVM alias analysis.
62+
- Join [LLVM Alias Analysis Technical Call](https://bluejeans.com/101176001?src=join_info)
63+
- Time: Tuesdays 10:00 AM Pacific Time, every 4 weeks.
64+
- The agenda is in this [Google Doc](https://docs.google.com/document/d/1ybwEKDVtIbhIhK50qYtwKsL50K-NvB6LfuBsfepBZ9Y/).
65+
66+
### OpenMP Technical Call
67+
68+
- Development updates on OpenMP and OpenACC in the Flang Project.
69+
- Join [OpenMP Technical Call](https://bit.ly/39eQW3o)
70+
- Time: Weekly call on every Thursdays 8:00 AM Pacific time.
71+
- Meeting minutes are [here](https://docs.google.com/document/d/1yA-MeJf6RYY-ZXpdol0t7YoDoqtwAyBhFLr5thu5pFI).
72+
- Status tracking [page](https://docs.google.com/spreadsheets/d/1FvHPuSkGbl4mQZRAwCIndvQx9dQboffiD-xD0oqxgU0/edit#gid=0).
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{# This template defines sidebar which can be used to provide common links on
2+
all documentation pages. #}
3+
4+
<h3>Documentation</h3>
5+
6+
<ul class="want-points">
7+
<li><a href="https://github.com/llvm/llvm-project/blob/master/flang/README.md#getting-started">Getting Started</a></li>
8+
</ul>
9+
10+
<h3>Getting Involved</h3>
11+
<! TODO: Point links to website(flang.llvm.org) and not github once webpage comes up.>
12+
<ul class="want-points">
13+
<li><a href="https://github.com/llvm/llvm-project/blob/master/flang/docs/GettingInvolved.md#mailing-lists">Mailing Lists</a></li>
14+
<li><a href="https://github.com/llvm/llvm-project/blob/master/flang/docs/GettingInvolved.md#chat">Slack</a></li>
15+
<li><a href="https://github.com/llvm/llvm-project/blob/master/flang/docs/GettingInvolved.md#calls">Calls</a></li>
16+
</ul>
17+
18+
<h3>Additional Links</h3>
19+
20+
<ul class="want-points">
21+
<li><a href="https://github.com/llvm/llvm-project/tree/master/flang/">Github Repository</a></li>
22+
<li><a href="https://bugs.llvm.org/">Bug Reports</a></li>
23+
<li><a href="https://reviews.llvm.org/">Code Review</a></li>
24+
<! TODO: Have the bots setup first>
25+
<li><a href="#">Doxygen API</a></li>
26+
</ul>

flang/docs/_templates/layout.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{% extends "!layout.html" %}
2+
3+
{% block extrahead %}
4+
<style type="text/css">
5+
table.right { float: right; margin-left: 20px; }
6+
table.right td { border: 1px solid #ccc; }
7+
</style>
8+
{% endblock %}
9+
10+
{% block rootrellink %}
11+
<! TODO: Change the webpage >
12+
<li><a href="https://flang.llvm.org">Flang Home</a>&nbsp;|&nbsp;</li>
13+
<li><a href="{{ pathto('index') }}">Documentation</a>&raquo;</li>
14+
{% endblock %}

flang/docs/conf.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,13 @@ def setup(app):
167167
#html_use_smartypants = True
168168

169169
# Custom sidebar templates, maps document names to template names.
170-
#html_sidebars = {}
170+
html_sidebars = {
171+
'**': [
172+
'indexsidebar.html',
173+
'searchbox.html',
174+
]
175+
}
176+
171177

172178
# Additional templates that should be rendered to pages, maps page names to
173179
# template names.

flang/docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Flang is LLVM's Fortran frontend
1515
.. toctree::
1616
:titlesonly:
1717
18+
GettingInvolved
1819
FortranForCProgrammers
1920
C++style
2021
C++17

0 commit comments

Comments
 (0)